Clarity_getOpenIndividual: Retrieve current individual records from a single source.
In MazamaScience/AirSensor2: Process and Display Data from Air Quality Sensors

Clarity_getOpenIndividual

R Documentation

Retrieve current individual records from a single source.

Description

Sends a request to the Clarity API endpoint for Open Data.

When format = "USFS2", two additional fields are returned in the "meta" dataframe: calibrationId and calibrationCategory.

Measurement data from – Drill down on one open datasource
Measurements returned – Individual values for last 3 days
PM2.5 Mass Concentration – Individual sample

Usage

Clarity_getOpenIndividual(
  api_key = NULL,
  datasourceId = NULL,
  format = c("USFS2", "USFS"),
  baseUrl = "https://clarity-data-api.clarity.io/v1/open/datasource-measurement"
)

Arguments

`api_key`	Clarity API READ Key. If `api_key = NULL`, it will be obtained using `getAPIKey("Clarity-read")`.
`datasourceId`	Clarity sensor identifier.
`format`	Customized output format ("USFS2", "USFS").
`baseUrl`	URL endpoint.

Value

List containing five data frames: meta, pm2.5_QCFlag, pm2.5, nowcast_QCFlag and nowcast.

Examples


# Fail gracefully if any resources are not available
try({

library(AirSensor2)

  Clarity_getOpenIndividual(
    api_key = Clarity_API_READ_KEY,
    datasourceId = "DAABL1560",
    format = "USFS2"
  )

}, silent = FALSE)

MazamaScience/AirSensor2 documentation built on Oct. 31, 2024, 1:39 a.m.