json_results: 'fromJSON' data request
In open-AIMS/dataaimsr: AIMS Data Platform API Client

json_results

R Documentation

`fromJSON` data request

Description

Wrapper function

Usage

json_results(dt_req)

Arguments

dt_req

An URL GET output

Details

This function submits a dt_req data request via fromJSON.

Value

aims_data returns a data.frame of class aimsdf.

If summary %in% c("summary-by-series", "summary-by-deployment"), the output shows the summary information for the target dataset (i.e. weather or temperature loggers) (NB: currently, summary only works for the temperature logger database). If summary is not passed as an additional argument, then the output contains raw monitoring data. If summary = "daily", then the output contains mean daily aggregated monitoring data. The output also contains five attributes (empty strings if summary is passed as an additional argument):

metadataa DOI link containing the metadata record for the data series.
citationthe citation information for the particular dataset.
parametersThe measured parameters comprised in the output.
typeThe type of dataset. Either "monitoring" if summary is not specified, "monitoring (daily aggregation)" if summary = "daily", or a "summary-by-" otherwise.
targetThe input target.