GetN.fn: Calculate input sample sizes

View source: R/GetN.fn.R

GetN.fnR Documentation

Calculate input sample sizes

Description

Calculate input sample sizes

Usage

GetN.fn(
  dir = NULL,
  dat,
  type = c("length", "age"),
  species = c("all", "flatfish", "shelfrock", "sloperock", "thorny", "others"),
  printfolder = "forSS3",
  output = NULL,
  verbose = TRUE
)

Arguments

dir

Directory where output will be saved. The directory where the file should be saved. If dir = NULL no output will be saved.

dat

A data frame of composition data created using pull_bio().

type

A string specifying whether doing "length" or "age" that is used to ensure the sample size is of the correct column and create the file name of the saved sheet.

species

A string specifying the species group of interest, which will lead to the use of the correct species-specific value for the number of unique samples per tow. See the function call for allowed values, where the default is "all".

printfolder

A string that will be appended to dir, creating a folder where the output will be saved. If specified as "", the output will just be saved directly in dir. The default is "forSS3".

output

A string, where the default is NULL, which returns only a vector of samples sizes. "summary", or any other character string, will return a table of observations by year and sex.

verbose

A logical that specifies if you want to print messages and warnings to the console. The default is TRUE.

Author(s)

Chantel R. Wetzel

References

Stewart, I.J. and O.S. Hamel. 2014. Bootstrapping of sample size for length- or age-composition data used in stock assessment. Canadian Journal of Fishery and Aquatic Science, 71(4): 581–588. 10.1139/cjfas-2013-0289.

Examples

## Not run: 
bio <- pull_bio(
  common_name = "petrale sole",
  survey = "NWFSC.Combo"
)

n <- GetN.fn(
  dat = bio,
  type = "length",
  species = "flatfish"
)

## End(Not run)


nwfsc-assess/nwfscSurvey documentation built on Nov. 12, 2024, 8:14 p.m.