inputList_SizeCompsData: Create an input list for size comps data

View source: R/writeFunctions.R

inputList_SizeCompsDataR Documentation

Create an input list for size comps data

Description

Function to create an input list for size comps data.

Usage

inputList_SizeCompsData(
  dfrZCs = NULL,
  dfrSSs = NULL,
  cutpts = NULL,
  tail_compression = c(0, 0),
  optFit = c("BY_X", "BY_XM"),
  likeType = c("MULTINOMIAL", "DIRICHLET-MULTINOMIAL"),
  likeWgt = 1,
  unitsIn = c("ONES", "MILLIONS"),
  unitsOut = c("MILLIONS", "ONES")
)

Arguments

dfrZCs

: size comps dataframe

dfrSSs

: sample sizes dataframe

cutpts

: vector of cutpoints for size comps

tail_compression

: 2-element vector giving tail compression factors

optFit

: objective function fitting option (e.g., "BY_X","BY_XM")

likeType

: likelihood type ("NORM2", "NORMAL" or "LOGNORMAL")

likeWgt

-likelihood multiplier

unitsIn

: units for input data ("ONES" or "MILLIONS")

unitsOut

: units for output data ("ONES" or "MILLIONS")

Details

See below:

Output list has elements:

  • dfrZCs - size comps dataframe

  • dfrSSs - sample sizes dataframe

  • cutpts - cutpoints for size comps

  • tail_compression - 2-element vector giving tail compression factors

  • optFit - objective function fitting option

  • likeType - likelihood type

  • likeWgt - likelihood multiplier

  • unitsIn - input units

  • unitsOut - output units

Value

a list (see Details).


wStockhausen/tcsamFunctions documentation built on Jan. 28, 2024, 9:01 a.m.