Pdata
for season.getSeason.Rd
Several seasonal schemes are available, including Petrale seasons
(1 = winter months, 2 else).
Most assessments won't require getSeason
because it is included
in cleanPacFIN. If a specialized season structure is required,
getSeason
should be run immediately after cleanPacFIN.
getSeason(
Pdata,
season_type = -1,
yearUp = NULL,
yearDown = NULL,
plotResults = FALSE,
verbose = TRUE
)
A data frame of biological samples
originating from the
Pacific Fishieries Information Network (PacFIN) data warehouse,
which originated in 2014. Data are pulled using sql calls, see
PullBDS.PacFIN()
.
Specify a numeric
value for season type.
If negative then all months will be assigned to season 1
.
If 0
then seasons will be assigned from Pdata$SAMPLE_MONTH
,
where each month is a unique season.
If 1
then seasons are assigned according to methods used for Petrale,
where winter months (c(11:12, 1:2)
) are season 1
and
the remaining months (summer) are assigned to season 2
.
Please contact the package maintainer should you wish to include an
additional seasonal scheme.
Used to provide a list of months (i.e., 1:12
)
for which to adjust the year (Pdata$fishyr
) up. For example,
if winter months belong to the following year then use yearUp = 11:12
.
Used to provide a list of months (i.e., 1:12
)
for which to adjust the year (Pdata$fishyr
) down. For example,
if winter months belong to the previous year then use yearUp = 1:2
.
A logical value specifying if plots should or should not be created and shown in the console.
A logical 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 information that you already know. The printing
of output to the screen does not affect any of the returned objects. The
default is to always print to the screen, i.e., verbose = TRUE
.
An additional column season
is added to Pdata
.
No columns are modified.
test <- getSeason(
data.frame(SAMPLE_MONTH = 1:12, fishyr = rep(1:2, each = 6)),
verbose = TRUE
)
testthat::expect_true(all(test[, "season"] == 1))
test <- getSeason(Pdata = test, season_type = 1, yearUp = 12)
#> Assigning seasons for Petrale; winter == 1, summer == 2.
#> Incremented fishyr for months 12to the next year.
testthat::expect_equivalent(test[test[, "fishyr"] == 3, "season"], 1)