create_raster {pargasite}

Raster creation function

Description

This function is used internally by create_pargasite_data, allowing users to specify a longitude/latitude bounding box. It is exported for package development, not for direct user calls.

Usage

create_raster(
  parameter_code,
  pollutant_standard = NULL,
  data_field = c("NAAQS_statistic", "arithmetic_mean"),
  event_filter = c("Events Included", "Events Excluded", "Concurred Events Excluded"),
  year,
  by_month = FALSE,
  minlat = 24,
  maxlat = 50,
  minlon = -124,
  maxlon = -66,
  crs = 6350,
  cell_size = 10000,
  aqs_email = get_aqs_email(),
  aqs_key = get_aqs_key(),
  nmax = Inf,
  download_chunk_size = c("2-week", "month")
)

Arguments

parameter_code

A numeric value specifying a AQS parameter code.

pollutant_standard

A vector of strings specifying unique pollutant standards in AQS (e.g., PM25 Annual 2012).

data_field

A vector of strings specifying whether which data fields are used to summarize the data. Must be either 'NAAQS statistic', 'arithmetic_mean', or both. 'NAAQS_statistic' try to chooses an appropriate field based on National Ambient Air Quality Standards (NAAQS) in the AQS yearly data (e.g, for CO 1-hour average, 'second_max_value' would be chosen). 'arithmetic_mean' represents the measure of central tendency in the yearly data. Ignored when by_month = TRUE.

event_filter

A vector of strings indicating whether data measured during exceptional events are included in the summary. 'Events Included' means that events occurred and the data from theme is included in the summary. 'Events Excluded' means that events occurred but data from them is excluded from the summary. 'Concurred Events Excluded' means that events occurred but only EPA concurred exclusions are removed from the summary. If multiple values are specified, pollutant levels for each filter are stored in event dimension in the resulting output.

year

A vector of 4-digit numeric values specifying years to retrieve pollutant levels.

by_month

A logical value indicating whether data summarized at monthly level instead of yearly level.

minlat, maxlat, minlon, maxlon

A numeric value specifying a bounding box defined by two latitudes and two longitudes.

crs

A target coordinate reference system.

cell_size

A numeric value specifying a cell size of grid cells in meters.

aqs_email

A string specifying the registered email for AQS API service.

aqs_key

A string specifying the registered key for AQS API service.

nmax

An integer value specifying the number of nearest observations that should be used for spatial interpolation.

download_chunk_size

A string specifying a chunk size for AQS API daily data download to prevent an unexpected server timeout error. Ignored when by_month = FALSE.

Value

A stars object containing the interpolated pollutant levels covering the user-specified bounding box.

Examples

## Not run: 

## Set your AQS API key first using [raqs::set_aqs_user] to run the example.

## SO2 through 2021 to 2022
so2 <- create_raster(42401, event_filter = "Events Included",
                     year = 2021:2022)

## End(Not run)