argo_read_meta: Read Argo float meta

In ArgoCanada/argodata: Locate, Download, and Read Argo Ocean Float Data

Description

Use argo_read_meta_*() functions to extract meta information from a previously-downloaded Argo NetCDF file.

Use argo_read_tech_tech_param() to extract technical specifications from a previously-downloaded Argo NetCDF file.

Usage

argo_read_meta_config_param(file, vars = NULL, quiet = FALSE)

argo_read_meta_missions(file, vars = NULL, quiet = FALSE)

argo_read_meta_trans_system(file, vars = NULL, quiet = FALSE)

argo_read_meta_positioning_system(file, vars = NULL, quiet = FALSE)

argo_read_meta_launch_config_param(file, vars = NULL, quiet = TRUE)

argo_read_meta_sensor(file, vars = NULL, quiet = quiet)

argo_read_meta_param(file, vars = NULL, quiet = quiet)

argo_read_tech_tech_param(file, vars = NULL, quiet = FALSE)

Arguments

file	A previously downloaded Argo NetCDF file (e.g., using argo_download()).
vars	A vector of variable names to include. Explicitly specifying vars can lead to much faster read times when reading many files.
quiet	Use FALSE to stop for malformed files, NA to silently warn for malformed files, or TRUE to silently ignore read errors when possible.

Value

A tibble::tibble() with

• argo_meta_config_param(): one row per configuration parameter and columns n_config_param, N_MISSIONS, CONFIG_PARAMETER_VALUE, and CONFIG_PARAMETER_NAME.

• argo_meta_missions(): one row per mission and columns N_MISSIONS, CONFIG_MISSION_NUMBER, and CONFIG_MISSION_COMMENT.

• argo_meta_trans_system(): one row per transmission system and columns N_TRANS_SYSTEM, TRANS_SYSTEM, TRANS_SYSTEM_ID, and TRANS_FREQUENCY.

• argo_meta_positioning_system(): one row per positioning system and columns N_POSITIONING_SYSTEM, and POSITIONING_SYSTEM.

• argo_meta_launch_config_param(): one row per launch configuration parameter and columns N_LAUNCH_CONFIG_PARAM, LAUNCH_CONFIG_PARAMETER_NAME, and LAUNCH_CONFIG_PARAMETER_VALUE.

• argo_meta_sensor(): one row per sensor and columns N_SENSOR, SENSOR, SENSOR_MAKER, SENSOR_MODEL, and sensor_serial_no.

• argo_meta_param(): one row per parameter and columns N_PARAM, PARAMETER PARAMETER_SENSOR, PARAMETER_UNITS, PARAMETER_RESOLUTION, PREDEPLOYMENT_CALIB_EQUATION, PREDEPLOYMENT_CALIB_COEFFICIENT, and PREDEPLOYMENT_CALIB_COMMENT.

A tibble::tibble() with one row per technical parameter and columns N_TECH_PARAM, TECHNICAL_PARAMETER_NAME, TECHNICAL_PARAMETER_VALUE, and CYCLE_NUMBER.

Examples

meta_file <- system.file(
  "cache-test/dac/csio/2900313/2900313_meta.nc",
  package = "argodata"
)

argo_read_meta_config_param(meta_file)
argo_read_meta_missions(meta_file)
argo_read_meta_trans_system(meta_file)
argo_read_meta_positioning_system(meta_file)
argo_read_meta_launch_config_param(meta_file)
argo_read_meta_sensor(meta_file)
argo_read_meta_param(meta_file)

tech_file <- system.file(
  "cache-test/dac/csio/2900313/2900313_tech.nc",
  package = "argodata"
)

argo_read_tech_tech_param(tech_file)

ArgoCanada/argodata documentation built on Dec. 13, 2021, 10:13 a.m.