getState: Create a state field from 'source' for the 'data.frame'

Description Usage Arguments

View source: R/getState.R

Description

Pdata, where Pdata is a data.frame from PacFIN.#'

Workflow

getState is run by cleanPacFIN.

Usage

1
2
getState(Pdata, source = "SOURCE_AGID", CLEAN = TRUE, keepPW = FALSE,
  verbose = TRUE)

Arguments

Pdata

A PacFIN data.frame

source

The column name where state information is located in Pdata. Typical options are 'SOURCE_AGID', 'PSMFC_ARID', or 'SAMPLE_AGENCY'.

CLEAN

A logical value indicating if records for which state cannot be assigned are removed or if just summary stats on what would have been removed are generated.

keepPW

A logival value indicating if records for Pacific Whiting should be removed or kept in as their own state.

verbose

A logical value specifying if output should be written to the screen or not. Good for testing and exploring your data but can be turned off when output indicates errors. The default value is TRUE.


nwfsc-assess/PacFIN.Utilities documentation built on June 30, 2017, 8:49 a.m.