extractMDFR.Pop.CohortProgression: Function to extract cohort progression by year among several...

In wStockhausen/rCompTCMs: Package to compare TCSAM02, rsimTCSAM, and TCSAM2013 model runs

Function to extract cohort progression by year among several models as a dataframe

Description

This function extracts cohort progression by year among several models as a dataframe.

Usage

extractMDFR.Pop.CohortProgression(
  objs,
  cast = "x+m+s+z",
  scaleToDensity = FALSE,
  aggToCutpts = FALSE,
  cutpts = seq(25, 185, 5),
  years = "all",
  verbose = FALSE
)

Arguments

objs	list of resLst objects
cast	casting formula for excluding x,m,s,z factor levels from sums across the unspecified factors
scaleToDensity	flag to scale abundance to 1-mm size bins
aggToCutpts	flag to aggregate (rebin) to provided cutpts
cutpts	cutpoints to aggregate to
years	'all' or vector of years to include
verbose	flag (T/F) to print diagnostic information

Details

Results are extracted using rTCSAM2013::getMDFR.Pop.Abundance, rsimTCSAM::getMDFR.Pop.Abundance, and/or rTCSAM02::getMDFR.Pop.Abundance(), as appropriate., and cast to aggregate. This differs from extractMDFR.Pop.Abundance1.

If scaleToDensity is true, the size distribution after cast'ing is scaled to abundance/mm to allow easier comparison between models with different bin sizes. If aggToCutpts is true, the distribution(s) are re-binned (aggregated) to a common set of cutpoints.

Value

dataframe in canonical format

wStockhausen/rCompTCMs documentation built on Sept. 12, 2023, 3:13 p.m.