ooi_check_availability: Get deployment and annotation data associated with an OOI...
In oceanobservatories/ooim2mr: R Functions For Accessing OOI Science Data Through The M2M System
Description
Usage
Arguments
Value
Examples
View source: R/ooi_check_availability.R
Description
Get deployment and annotation data associated with an OOI site, node, and instrument.
Usage
1
ooi_check_availability(site, node, instrument, user, token)
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.
user
Your OOI API username.
token
Your OOI API token.
Value
A list of sublists. The deployments sublist offers start and stop deployments times for the given asset. The annotations sublists offers annotations for the given site,node, and instrument. Used together, a user can determine if data exists for the time period they are interested in.
Examples
1
availability = ooi_check_availability('CE01ISSM','SEAFLOOR','CTD','OOI-API-USERNAME-HERE','OOI-API-TOKEN-HERE')
oceanobservatories/ooim2mr documentation built on Oct. 2, 2020, 4:29 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Examples
View source: R/ooi_check_availability.R
Description
Get deployment and annotation data associated with an OOI site, node, and instrument.
Usage
1 | ooi_check_availability(site, node, instrument, user, token)
|
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. |
user |
Your OOI API username. |
token |
Your OOI API token. |
Value
A list of sublists. The deployments sublist offers start and stop deployments times for the given asset. The annotations sublists offers annotations for the given site,node, and instrument. Used together, a user can determine if data exists for the time period they are interested in.
Examples
1 | availability = ooi_check_availability('CE01ISSM','SEAFLOOR','CTD','OOI-API-USERNAME-HERE','OOI-API-TOKEN-HERE')
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.