SHARK4R (version 1.1.0)

find_required_fields: Find required fields in a SHARK delivery template

Description

Identifies which columns are mandatory in the SHARK delivery template based on rows starting with "*" (one or more). You can specify how many levels of asterisks to include.

Usage

find_required_fields(
  datatype,
  stars = 1,
  bacterioplankton_subtype = "abundance"
)

Value

A character vector of column names that are required in the template.

Arguments

datatype

Character. The datatype name. Available options include:

• "Bacterioplankton" (subtypes: "abundance", "production")

• "Chlorophyll"

• "Epibenthos" (dive transect)

• "Dropvideo" (epibenthos drop video)

• "Grey seal"

• "Harbour seal"

• "Ringed seal"

• "Harbour Porpoise"

• "Physical and Chemical"

• "Primary production"

• "Phytoplankton"

• "Picoplankton"

• "Sedimentation"

• "Seal pathology"

• "Profile"

• "Zooplankton"

• "Zoobenthos"

stars

Integer. Maximum number of "" levels to include. Default = 1 (only single ""). For example, stars = 2 includes "" and "**", stars = 3 includes "", "", and "*".

bacterioplankton_subtype

Character. For "Bacterioplankton" only: either "abundance" (default) or "production". Ignored for other datatypes.

Details

Note: A single "*" marks required fields in the standard SHARK template. A double "**" is often used to specify columns required for national monitoring only. For more information, see: https://www.smhi.se/data/hav-och-havsmiljo/datavardskap-oceanografi-och-marinbiologi/leverera-data

Examples

# \donttest{
# Only single "*" required columns
try(find_required_fields("Bacterioplankton"))

# Include both "*" and "**" required columns (national monitoring too)
try(find_required_fields("Bacterioplankton", stars = 2))

# Include up to three levels of "*"
try(find_required_fields("Phytoplankton", stars = 3))
# }