AirSensor (version 1.0.2)

pas_getLabels: Return labels from filtered PurpleAir Synoptic objects

Description

The incoming pas object is first filtered based on the values of stateCodes, pattern, isOutside and isParent. The values associated with the "label" column are then returned.

This function is useful for returning values associated with specific devices, which are represented by records with isParent = TRUE.

Usage

pas_getLabels(
  pas = NULL,
  pattern = ".*",
  idPattern = ".*",
  isOutside = TRUE,
  isParent = TRUE
)

Arguments

pas

PurpleAir Synoptic pas object.

pattern

Text pattern used to filter station labels.

idPattern

Text pattern used to filter deviceDeploymentID.

isOutside

Logical, is the sensor located outside?

isParent

Logical, is the record associated with a the A channel?

Value

Vector of values.

See Also

pas_getColumn, pas_getIDs, pas_getDeviceDeploymentIDs

Examples

# NOT RUN {
library(AirSensor)

pas <- example_pas

pas_getLabels(pas = pas) %>% head(10)

pas_getLabels(pas = pas, pattern = "back") %>% head(10)


# }