ooi_create_url: Generate an OOI request URL through a curated remote lookup...

In oceanobservatories/ooim2mr: R Functions For Accessing OOI Science Data Through The M2M System

Description

Generate an OOI request URL through a curated remote lookup table.

Usage

ooi_create_url(
  site = "",
  node = "",
  instrument = "",
  method = "",
  stream = "",
  start_date = "2010-01-01",
  start_time = "00:00:00",
  stop_date = "2040-12-31",
  stop_time = "23:59:59"
)

Arguments

site	An eight (8) character designator for OOI sites.
node	A five (5) character designator for OOI nodes. Alternatively, a simplified string for OOI sites that is greater than 5 characters. grep allows for use of substrings.
instrument	A twelve (12) character designator for the OOI instrument on the associated site and node. grep allows for use of substrings.
method	An indicator for how the data was delivered. Options are recovered_cspp, recovered_host, recovered_inst, streamed, telemetered.
stream	Optional: Default is an empty string. If utilized, it helps narrow URL selection to a single URL. grep allows for use of substrings.
start_date	The UTC start date of the data request in the format of YYYY-mm-dd. Default is 2010-01-01.
start_time	The UTC start time of the data request in the format of HH:MM:SS. Default is 00:00:00.
stop_date	The UTC stop date of the data request in the format of YYYY-mm-dd. Default is 2040-12-31.
stop_time	The UTC stop time of the data request in the format of HH:MM:SS. Default is 23:59:59.

Value

The request URL generated from input parameters. If more than one URL is created from the inputs, a list of URLs is returned, prompting the user to finetune their selection.

Examples

url = ooi_create_url(site = 'CE02SHSP',node = 'PROFILER',instrument = 'CTD',method = 'recovered_cspp') #Requests CE02SHSP CTD data that was recovered from the profiler for the OOI lifespan (excluded parameters use defaults).
url = ooi_create_url(site = 'CE05MOAS',node = 'GL382',instrument = 'DO',method = 'telemetered',start_date = '2019-01-10',stop_date = '2019-01-31') #Requests EA Glider 382 DO data that was telemetered from the glider for the first month of 2019.
urls = ooi_create_url(site = 'CE') #This would return all assets within the Endurance Array.

oceanobservatories/ooim2mr documentation built on Oct. 2, 2020, 4:29 p.m.