R/planktonr_dat.R
planktonr_dat.RdThis function creates a planktonr_dat object, which is a tibble
with additional custom attributes for metadata. It can accept
either a data.frame or a tibble, coercing data.frame inputs to tibble.
planktonr_dat(
.data,
Type = NULL,
Survey = NULL,
Variable = NULL,
Model = NULL,
...
)The data data.frame or tibble to be converted to the planktonr_dat class.
The data type. Must be one of "Microbes", "Phytoplankton", "Zooplankton", "Water", or "EOV".
The survey of the data. E.g., "NRS", "CPR", "LTM", "GO-SHIP", "Coastal".
What variable is being described or subsetted by this data.
Optional model associated with the data.
Additional attributes to be stored with the planktonr_dat object.
These will be stored as attributes on the object.
An object of class planktonr_dat.
# Create from a tibble (existing behavior)
tibble_data <- tibble::tibble(
time = as.Date(c("2023-01-01", "2023-01-02")),
value = c(10, 20)
)
pr_obj_tibble <- planktonr_dat(
.data = tibble_data,
Type = "Phytoplankton",
Survey = "NRS",
Variable = "Chlorophyll_a"
)
print(pr_obj_tibble)
#> --- planktonr_dat Attributes ---
#> Type: Phytoplankton
#> Survey: NRS
#> Variable: Chlorophyll_a
#>
#> # A tibble: 2 × 2
#> time value
#> <date> <dbl>
#> 1 2023-01-01 10
#> 2 2023-01-02 20
# Create from a base R data.frame (newly supported)
df_data <- data.frame(
time = as.Date(c("2023-01-03", "2023-01-04")),
value = c(30, 40)
)
pr_obj_df <- planktonr_dat(
.data = df_data,
Type = "Zooplankton",
Survey = "CPR",
Variable = "Biomass"
)
print(pr_obj_df)
#> --- planktonr_dat Attributes ---
#> Type: Zooplankton
#> Survey: CPR
#> Variable: Biomass
#>
#> # A tibble: 2 × 2
#> time value
#> <date> <dbl>
#> 1 2023-01-03 30
#> 2 2023-01-04 40
class(pr_obj_df) # Still a planktonr_dat (which inherits from tibble)
#> [1] "planktonr_dat" "tbl_df" "tbl" "data.frame"