getCpodData: Retrieve C-POD data from the LifeWatch project

View source: R/lwdataFunctions.R

getCpodDataR Documentation

Retrieve C-POD data from the LifeWatch project

Description

Retrieves the C-POD (Cetacean Acoustic Hydrophone Network) data from the LifeWatch project. Need valid authentication to access the entire data.To get an account, register via the Lifewatch RShiny registration webpage.

Usage

getCpodData(
  startdate,
  stopdate,
  processing,
  quality = c("Hi", "Mod", "Lo"),
  by,
  usr = NULL,
  pwd = NULL,
  params = FALSE,
  ...
)

Arguments

startdate

Starting date for the query

stopdate

Stopping date for the query

processing

One of ('Validated','Raw'). If "Validated", the quality parameter is ignored.

quality

One or more of ("Hi","Mod", "Lo"). This parameter is ignored if processing = "Validated"

by

Sample period, one of ("1 day", "1 week", "60 min","10 min", "1 min")

usr

Username to connect to ETN database

pwd

Password to connect to ETN database

params

If TRUE, returns a list with the dataset and the query parameters applied in the server side. IF FALSE returns only the data.

...

Reserved for internal use.

Value

Dataframe with the specified C-POD data.

Examples

getCpodData("2020-04-19", "2020-04-21", processing = "Validated", by = "1 week")
getCpodData("2020-04-19", "2020-04-21", processing = "Raw",
quality = c("Hi", "Lo"), by = "1 day", params = TRUE)

lifewatch/lwdataexplorer documentation built on Aug. 24, 2024, 12:35 a.m.