read_data: Read FORCIS data

In FRBCesab/forcis: An R Client to Access the FORCIS Database

Read FORCIS data

Description

These functions read one specific csv file of the FORCIS database (see below) stored in the folder path. The function download_forcis_db() must be used first to store locally the database.

Usage

read_cpr_north_data(
  path = ".",
  version = options()$forcis_version,
  check_for_update = options()$check_for_update
)

read_cpr_south_data(
  path = ".",
  version = options()$forcis_version,
  check_for_update = options()$check_for_update
)

read_plankton_nets_data(
  path = ".",
  version = options()$forcis_version,
  check_for_update = options()$check_for_update
)

read_pump_data(
  path = ".",
  version = options()$forcis_version,
  check_for_update = options()$check_for_update
)

read_sediment_trap_data(
  path = ".",
  version = options()$forcis_version,
  check_for_update = options()$check_for_update
)

Arguments

path	a character of length 1. The folder in which the FORCIS database has been saved.
version	a character of length 1. The version number (with two numbers, e.g. 08 instead of 8) of the FORCIS database to use. Default is the latest version. Note that this argument can be handle with the global option forcis_version. For example, if user calls options(forcis_version = "07"), the version 07 will be used by default for the current R session. Note that it is recommended to use the latest version of the database.
check_for_update	a logical. If TRUE (default) the function will check if a newer version of the FORCIS database is available on Zenodo and will print an informative message. Note that this argument can be handle with the global option check_for_update. For example, if user calls options(check_for_update = FALSE), the message to download the latest version will be disabled for the current R session.

Details

• read_plankton_nets_data() reads the FORCIS plankton nets data

• read_pump_data() reads the FORCIS pump data

• read_cpr_north_data() reads the FORCIS CPR North data

• read_cpr_south_data() reads the FORCIS CPR South data

• read_sediment_trap_data() reads the FORCIS sediment traps data

Value

A data.frame. See https://zenodo.org/doi/10.5281/zenodo.7390791 for a preview of the datasets.

See Also

download_forcis_db() to download the complete FORCIS database.

Examples

## Not run: 
# Attach the package ----
library("forcis")

# Folder in which the database will be saved ----
path_to_save_db <- "data"

# Download the database ----
download_forcis_db(path = path_to_save_db)

# Import plankton nets data ----
plankton_nets_data <- read_plankton_nets_data(path = path_to_save_db)

## End(Not run)

FRBCesab/forcis documentation built on Oct. 25, 2024, 9:26 a.m.