odf_update_metadata: Update existing ODF format list with standard metadata and...

View source: R/odf_update_metadata.R

odf_update_metadataR Documentation

Update existing ODF format list with standard metadata and project/deployment level metadata

Description

Update existing ODF format list with standard metadata and project/deployment level metadata

Usage

odf_update_metadata(
  x,
  project,
  project_lead,
  organization = c("DFO-MPO", "DFO-MPO MARSCI", "DFO-MPO CESD"),
  institute = NA_integer_,
  latitude,
  longitude,
  end_latitude = NA_real_,
  end_longitude = NA_real_,
  depth_m,
  depth_type = c("surface", "bottom"),
  min_depth,
  max_depth,
  sampling_interval = NA_real_,
  sounding = NA_real_,
  depth_off_bottom = NA_real_,
  event_comments
)

Arguments

x

R object to update

project

Which program/project collected this data? Required if going to the ODIS datashop for a cruise number, or just for knowing what program generated the data.

project_lead

the person responsible for this data at the program level. this is usually the project/program lead, not a field technician collecting the data.

organization

'DFO-MPO' is the default, but if it needs to be more specific can modify here.

latitude

latitude in decimal degrees North(dd.ddddd\deg) where the instrument was moored.

longitude

longitude in decimal degrees East (-ddd.dddd\deg) where the instrument was deployed *should be negative in the Western Hemisphere!*

depth_m

depth of the instrument in meters.

depth_type
intitute

numeric institute code for the collecting research institution, BIO is 1810. Don't know where these codes come from.

Value

an updated list of metadata for the creation of an ODF compliant file

Examples

odf_update_metadata(project = "CSRF1234", project_lead = "Joe Somebody", organization = "DFO-MPO", latitude = 45, longitude = -65, depth_m = 10, depth_type = "bottom")

pkraska/CESD documentation built on June 15, 2025, 6:32 a.m.