regcensus (version 1.0.1)

get_reading_time: get_reading_time

Description

Convert word counts to total reading time

Usage

get_reading_time(
  series = 2,
  jurisdiction,
  year,
  document_type = 1,
  summary = TRUE,
  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
)

Value

Returns pandas dataframe with the metadata

Arguments

series

Series ID (s), default value is 2 here

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 TRUE

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

industry_level is deprecated; use label_level

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

Examples

if (FALSE) get_reading_time(
  jurisdiction = 45,
  year = array(c(2022, 2023))
)