extractIndivIDs: Extract unique IDs for individuals from a DisMELS model run

Description Usage Arguments Details Value

Description

Function to extract unique IDs for individuals from a DisMELS model run.

Usage

1
2
3
4
5
extractIndivIDs(indivConn = NULL, lhsTypeInfo = NULL,
  onlySuccessful = FALSE, onlyUnsuccessful = FALSE,
  successful = "where (end_typeName=\"benthic.juvenile\")",
  nurseryZones = c("NurseryArea_000to050m", "NurseryArea_050to150m"),
  verbose = FALSE)

Arguments

indivConn

- individual connectivity file (or dataframe)

lhsTypeInfo

- life stage info list for IBM (req'd if onlySuccessful=TRUE or onlyUnsuccessful=TRUE)

onlySuccessful

- flag (T/F) to pull out only successful individuals

onlyUnsuccessful

- flag (T/F) to pull out only unsuccessful individuals

successful

- sql "where" clause to determine final state for individuals regarded as successful

nurseryZones

- vector of names of zones used as nursery areas in the IBM (req'd if onlySuccessful or onlyUnsuccessful=TRUE)

verbose

- flag (T/F) to print debugging info

Details

If onlySuccessful=TRUE, then it is assumed that 'successful' individuals are those which are in one of the nursery areas and meet the 'successful' criteria.

If onlyUnsuccessful=TRUE, then it is assumed that 'unsuccessful' individuals are those which don't meet the 'successful' criteria.

Value

data frame with columns ID, start_typeName,start_depthzone,start_alongshorezone,end_typeName,end_depthzone,end_alongshorezone


wStockhausen/wtsDisMELSConn documentation built on May 3, 2019, 7:36 p.m.