get_document_values: get_document_values

In regcensus: Accessing Data from the 'RegCensusAPI'

get_document_values

Description

Get values for a specific jurisdiction and series at the document level

Usage

get_document_values(
  series,
  jurisdiction,
  year,
  document_type = 1,
  summary = FALSE,
  date_is_range = TRUE,
  country = FALSE,
  agency = NULL,
  cluster = NULL,
  label = NULL,
  industry = NULL,
  filtered = TRUE,
  label_level = 3,
  industry_level = NULL,
  label_source = "NAICS",
  version = NULL,
  download = FALSE,
  page = NULL,
  date = NULL,
  verbose = 0
)

Arguments

series	Series ID (s)
jurisdiction	ID for the jurisdiction
year	Year(s) of data
document_type	ID for type of document, default value of 1
summary	Return summary instead of document level data (only one year of data is allowed for document level data), default value is FALSE here
date_is_range	Indicating whether the time parameter is range or should be treated as single data points, default value is TRUE
country	Get values for all subjurisdictions, default value is FALSE
agency	Agency ID, default value is NULL
cluster	Cluster ID
label	Industry code using the jurisdiction-specific coding system (returns all 3-digit industries by default), default value is NULL
industry	industry is deprecated; use label
filtered	Exclude poorly-performing industry results (use of unfiltered results is NOT recommended), default value is TRUE
label_level	Level of NAICS industries to include, default value is 3
industry_level	industryLevel is deprecated; use labellevel
label_source	classification standard (NAICS, BEA, SOC), default value of "NAICS"
version	Version ID for datasets with multiple versions (if no ID is given, returns most recent version), default value is NULL
download	If not False, a path location for a downloaded csv of the results, default value is FALSE
page	Page Number of the Response, default value is NULL
date	date is deprecated, use year now
verbose	Print out the url of the API call (useful for debugging), default value is 0

Value

Returns pandas dataframe with the metadata

Examples

## Not run: get_document_values(
  series = 33, jurisdiction = 38,
  year = 2018, label = "111"
)
## End(Not run)

regcensus documentation built on Oct. 4, 2023, 1:07 a.m.