pat_isPat: Test for correct structure in a _pat_ object

View source: R/utils-paTimeseries.R

pat_isPatR Documentation

Test for correct structure in a pat object

Description

The pat is checked for the 'pat' class name and presence of core meta and data columns.

Core meta columns include:

  • ID – Purple Air ID

  • label – location label

  • sensorType – PurpleAir sensor type

  • longitude – decimal degrees E

  • latitude – decimal degrees N

  • timezone – Olson timezone

  • countryCode – ISO 3166-1 alpha-2

  • stateCode – ISO 3166-2 alpha-2

  • pwfsl_closestDistance – distance in meters from an official monitor

  • pwfsl_closestMonitorID – identifer for the nearest official monitor

The "pwfsl", official, monitors are obtained from the USFS AirFire site using the PWFSLSmoke R package.

Core data columns include:

  • datetime – measurement time (UTC)

  • pm25_A – A channel PM 2.5 concentration (ug/m3)

  • pm25_B – B channel PM 2.5 concentration (ug/m3)

  • temperature – temperature (F)

  • humidity – relative humidity (%)

The "pwfsl", official, monitors are obtained from the USFS AirFire site using the PWFSLSmoke R package.

Usage

pat_isPat(pat = NULL)

Arguments

pat

pat object

Value

TRUE if pat has the correct structure, FALSE otherwise.

Examples

pat_isPat(example_pat)


MazamaScience/AirSensor documentation built on April 28, 2023, 11:16 a.m.