Onc-class {onc.api}

Onc Class

Description

Provides convenient & easy access to Ocean Networks Canada's data. For detailed information and usage examples, visit our official Documentation.

Arguments

token

User token

production

whether the ONC Production server URL is used for service requests

showInfo

Whether verbose debug messages are displayed

outPath

Output path for downloaded files

timeout

Number of seconds before a request to the API is canceled

Fields

token

character. User token

showInfo

logical. Print verbose debug comments

timeout

numeric. Number of seconds before a request to the API is canceled

baseUrl

character. Base URL for API requests

outPath

character. Output path for downloaded files

Class initializer

Methods

downloadDataProduct( runId = 0, maxRetries = 0, downloadResultsOnly = FALSE, includeMetadataFile = TRUE, overwrite = FALSE )

Manually download a data product after it was requested and run

formatUtc(dateString = "now")

Formats the provided date string to meet ISO8601

getDataProducts(filters = list())

Returns a filtered list of data products

getDeployments(filters = list())

Returns a filtered list of deployments

getDeviceCategories(filters = list())

Returns a filtered list of device categories

getDevices(filters = list())

Returns a filtered list of devices

getDirectByDevice(filters = list(), allPages = FALSE)

Obtain scalar data readings from a device

getDirectByLocation(filters = list(), allPages = FALSE)

Obtain scalar data readings from a device category in a location

getDirectFiles(filters = list(), overwrite = FALSE, allPages = FALSE)

Download a list of archived files that match the filters provided

getDirectRawByDevice(filters = list(), allPages = FALSE)

Obtain raw data readings from a device

getDirectRawByLocation(filters = list(), allPages = FALSE)

Obtain raw data readings from a device category in a location

getFile(filename = "", overwrite = FALSE)

Download a file with the given filename

getListByDevice(filters = list(), allPages = FALSE)

Get a list of archived files for a device

getListByLocation(filters = list(), allPages = FALSE)

Get a list of archived files for a device category in a location

getLocationHierarchy(filters = list())

Returns a filtered locations tree

getLocations(filters = list())

Returns a filtered list of locations

getProperties(filters = list())

Returns a filtered list of properties

orderDataProduct( filters = list(), maxRetries = 0, downloadResultsOnly = FALSE, includeMetadataFile = TRUE, overwrite = FALSE )

Request, run and download a data product

print(data, filename = "")

Prints a named list in a format easier to read

requestDataProduct(filters = list())

Manually Request a data product

runDataProduct(dpRequestId = 0, waitComplete = FALSE)

Manually run a data product request