Skip to content

Commit

Permalink
docs: updated example datasets
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathan Callahan committed Aug 12, 2023
1 parent 4fd01a4 commit fd826b8
Show file tree
Hide file tree
Showing 9 changed files with 46 additions and 28 deletions.
8 changes: 4 additions & 4 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ URL: https://github.com/MazamaScience/AirSensor2
BugReports: https://github.com/MazamaScience/AirSensor2/issues
Depends:
R (>= 4.0.0),
MazamaCoreUtils (>= 0.4.14)
MazamaCoreUtils (>= 0.4.15)
Imports:
AirMonitor (>= 0.3.9),
AirMonitor (>= 0.3.11),
countrycode,
dplyr (>= 1.0.0),
geodist,
Expand All @@ -26,8 +26,8 @@ Imports:
lubridate,
magrittr,
MazamaLocationUtils (>= 0.3.8),
MazamaSpatialUtils (>= 0.8.1),
MazamaTimeSeries (>= 0.2.10),
MazamaSpatialUtils (>= 0.8.5),
MazamaTimeSeries (>= 0.2.13),
readr,
rlang,
sf,
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@

# AirSensor2 0.3.5

- Updated Mazama package dependencies.
- Updated example datasets.


# AirSensor2 0.3.4

- Renamed `PurpleAir_createMonitor()` to `PurpleAir_createNewMonitor()`. This
Expand Down
30 changes: 18 additions & 12 deletions R/data.R
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
#' @encoding UTF-8
#' @title Example raw Purple Air Synoptic dataset
#' @format A tibble with 1996 rows and 37 columns of data.
#' @format A tibble with 2260 rows and 37 columns of data.
#' @description The \code{example_pas_raw} dataset provides a quickly loadable
#' version of raw Purple Air synoptic data for practicing and code
#' examples. This dataset contains data for sensors in Washington and Oregon
#' and was generated on 2023-05-03 by running:
#' version of raw Purple Air synoptic data for practicing and code examples
#' This dataset contains data for sensors in Washington and Oregon and was
#' generated on 2023-08-12 by running:
#'
#' \preformatted{
#' library(AirSensor2)
#'
#' initializeMazamaSpatialUtils()
#'
#' source("global_vars.R") # contains PurpleAir_API_READ_KEY
#'
#' example_pas_raw <-
#' pas_downloadParseRawData(
#' PurpleAir_API_READ_KEY,
Expand Down Expand Up @@ -40,17 +42,19 @@

#' @encoding UTF-8
#' @title Example enhanced Purple Air Synoptic dataset
#' @format A tibble with 1948 rows and 50 columns of data.
#' @format A tibble with 2209 rows and 50 columns of data.
#' @description The \code{example_pas} dataset provides a quickly loadable
#' version of a \emph{pas} object for practicing and code examples.
#' This dataset contains data for sensors in Washington and Oregon
#' and was generated on 2023-05-03 by running:
#' and was generated on 2023-08-12 by running:
#'
#' \preformatted{
#' library(AirSensor2)
#'
#' initializeMazamaSpatialUtils()
#'
#' source("global_vars.R") # contains PurpleAir_API_READ_KEY
#'
#' example_pas <-
#' pas_createNew(
#' api_key = PurpleAir_API_READ_KEY,
Expand All @@ -70,16 +74,18 @@


#' @encoding UTF-8
#' @title Example enhanced Purple Air Synoptic dataset
#' @format A tibble with 1948 rows and 50 columns of data.
#' @description The \code{example_pas} dataset provides a quickly loadable
#' version of a \emph{pas} object for practicing and code examples.
#' This dataset contains data for sensors in Washington and Oregon
#' and was generated on 2023-05-03 by running:
#' @title Example Purple Air Timeseries dataset
#' @format A list containing two tibbles named 'meta' and 'data'.
#' @description The \code{example_pat} dataset provides a quickly loadable
#' version of a \emph{pat} object for practicing and code examples.
#' This dataset contains 24 hours worth of data for a single PurpleAir sensor
#' and was generated on 2023-08-12 by running:
#'
#' \preformatted{
#' library(AirSensor2)
#'
#' source("global_vars.R") # contains PurpleAir_API_READ_KEY
#'
#' example_pat <-
#' pat_createNew(
#' api_key = PurpleAir_API_READ_KEY,
Expand Down
Binary file modified data/example_pas.rda
Binary file not shown.
Binary file modified data/example_pas_raw.rda
Binary file not shown.
Binary file modified data/example_pat.rda
Binary file not shown.
6 changes: 4 additions & 2 deletions man/example_pas.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 6 additions & 4 deletions man/example_pas_raw.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 8 additions & 6 deletions man/example_pat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fd826b8

Please sign in to comment.