Skip to contents

Construct a Socrata open data API (SODA) query for the NHSN Hospital Respiratory Data set.

Source: R/pull_nhsn.R
nhsn_soda_query.Rd

[Deprecated]

This function has been replaced the more general data_cdc_gov_soda_query(), which it now uses internally. Use that function instead.

Usage

nhsn_soda_query(
  api_endpoint,
  start_date = NULL,
  end_date = NULL,
  columns = NULL,
  jurisdictions = NULL,
  limit = 1e+05,
  order_by = c("jurisdiction", "weekendingdate"),
  desc = FALSE,
  ...
)

Arguments

api_endpoint

Base API endpoint URL to use when constructing the query.

start_date

Pull only rows with dates greater than or equal to this date. If NULL, no minimum date. Default NULL.

end_date

Pull only rows with dates less than or equal to this date. If NULL, no maximum date. Default NULL.

columns

Vector of columns to retrieve, in addition to weekendingdate and jurisdiction, which are always retrieved. If NULL, retrieve all columns. Default NULL.

jurisdictions

Vector of jurisdictions to retrieve, by two letter US postal service code. If NULL, retrieve all. Default NULL.

limit

limit to the number of rows to retrieve. Default 1e5.

order_by

Vector of columns by which to order the results. Default c("jurisdiction", "weekendingdate")

desc

whether to order descending instead of ascending. Default FALSE (order ascending).

...

additional arguments passed to data_cdc_gov_soda_query().

Value

the query as soql::soql() output