,
Jonathan Eyer [aut]| Title: | USDA NASS Quick Stats API |
|---|---|
| Description: | An alternative for downloading various United States Department of Agriculture (USDA) data from <https://quickstats.nass.usda.gov/> through R. You must sign up for an API token from the mentioned website in order for this package to work. |
| Authors: | Robert Dinterman [cre, aut] ,
Jonathan Eyer [aut] |
| Maintainer: | Robert Dinterman <[email protected]> |
| License: | GPL-3 |
| Version: | 0.1.1 |
| Built: | 2025-02-20 03:59:53 UTC |
| Source: | https://github.com/rdinter/usdarnass |
Take a character vector for each argument and concatenate them for API calls to Quick Stats. Arguments can be single objects or a vector and are not case sensitive.
args_list( key = NULL, param = NULL, source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, format = NULL, ... )args_list( key = NULL, param = NULL, source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, format = NULL, ... )
key |
API key, default is to use the value stored in |
param |
A valid parameter value. Available names are: source_desc, sector_desc, group_desc, commodity_desc, short_desc, domain_desc, domaincat_desc, agg_level_desc, statisticcat_desc, state_name, asd_desc, county_name, region_desc, zip_5, watershed_desc, year, freq_desc, and reference_period_desc. |
source_desc |
"Program" - Source of data ("CENSUS" or "SURVEY"). Census program includes the Census of Ag as well as follow up projects. Survey program includes national, state, and county surveys. |
sector_desc |
"Sector" - Five high level, broad categories useful to narrow down choices. ("ANIMALS & PRODUCTS", "CROPS", "DEMOGRAPHICS", "ECONOMICS", or "ENVIRONMENTAL") |
group_desc |
"Group" - Subsets within sector (e.g., under sector_desc = "CROPS", the groups are "FIELD CROPS", "FRUIT & TREE NUTS", "HORTICULTURE", and "VEGETABLES"). |
commodity_desc |
"Commodity" - The primary subject of interest (e.g., "CORN", "CATTLE", "LABOR", "TRACTORS", "OPERATORS"). |
class_desc |
Generally a physical attribute (e.g., variety, size, color, gender) of the commodity. |
prodn_practice_desc |
A method of production or action taken on the commodity (e.g., IRRIGATED, ORGANIC, ON FEED). |
util_practice_desc |
Utilizations (e.g., GRAIN, FROZEN, SLAUGHTER) or marketing channels (e.g., FRESH MARKET, PROCESSING, RETAIL). |
statisticcat_desc |
"Category" - The aspect of a commodity being measured (e.g., "AREA HARVESTED", "PRICE RECEIVED", "INVENTORY", "SALES"). |
unit_desc |
The unit associated with the statistic category (e.g., ACRES, $ / LB, HEAD, $, OPERATIONS). |
short_desc |
"Data Item" - A concatenation of six columns: commodity_desc, class_desc, prodn_practice_desc, util_practice_desc, statisticcat_desc, and unit_desc. |
domain_desc |
"Domain" - Generally another characteristic of operations that produce a particular commodity (e.g., "ECONOMIC CLASS", "AREA OPERATED", "NAICS CLASSIFICATION", "SALES"). For chemical usage data, the domain describes the type of chemical applied to the commodity. The domain_desc = "TOTAL" will have no further breakouts; i.e., the data value pertains completely to the short_desc. |
domaincat_desc |
"Domain Category" - Categories or partitions within a domain (e.g., under domain_desc = "SALES", domain categories include $1,000 TO $9,999, $10,000 TO $19,999, etc). |
agg_level_desc |
"Geographic Level" - Aggregation level or geographic granularity of the data. ("AGRICULTURAL DISTRICT", "COUNTY", "INTERNATIONAL", "NATIONAL", "REGION : MULTI-STATE", "REGION : SUB-STATE", "STATE", "WATERSHED", or "ZIP CODE") |
state_ansi |
American National Standards Institute (ANSI) standard 2-digit state codes. |
state_fips_code |
NASS 2-digit state codes; include 99 and 98 for US TOTAL and OTHER STATES, respectively; otherwise match ANSI codes. |
state_alpha |
State abbreviation, 2-character alpha code. |
state_name |
"State" - State full name. |
asd_code |
NASS defined county groups, unique within a state, 2-digit ag statistics district code. |
asd_desc |
"Ag District" - Ag statistics district name. |
county_ansi |
ANSI standard 3-digit county codes. |
county_code |
NASS 3-digit county codes; includes 998 for OTHER (COMBINED) COUNTIES and Alaska county codes; otherwise match ANSI codes. |
county_name |
"County" - County name. |
region_desc |
"Region" - NASS defined geographic entities not readily defined by other standard geographic levels. A region can be a less than a state (SUB-STATE) or a group of states (MULTI-STATE), and may be specific to a commodity. |
zip_5 |
"Zip Code" - US Postal Service 5-digit zip code. |
watershed_code |
US Geological Survey (USGS) 8-digit Hydrologic Unit Code (HUC) for watersheds. |
watershed_desc |
"Watershed" - Name assigned to the HUC. |
congr_district_code |
US Congressional District 2-digit code. |
country_code |
US Census Bureau, Foreign Trade Division 4-digit country code, as of April, 2007. |
country_name |
Country name. |
location_desc |
Full description for the location dimension. |
year |
"Year" - The numeric year of the data and can be either a character or numeric vector. Conditional values are also possible, for example a character vector of ">=1999" of "1999<=" will give years greater than or equal to 1999. Right now the logical values can either be greater/less than or equal to with the logical at either the beginning or end of a string with the year. |
freq_desc |
"Period Type" - Length of time covered ("ANNUAL", "SEASON", "MONTHLY", "WEEKLY", "POINT IN TIME"). "MONTHLY" often covers more than one month. "POINT IN TIME" is as of a particular day. |
begin_code |
If applicable, a 2-digit code corresponding to the beginning of the reference period (e.g., for freq_desc = MONTHLY, begin_code ranges from 01 (January) to 12 (December)). |
end_code |
If applicable, a 2-digit code corresponding to the end of the reference period (e.g., the reference period of JAN THRU MAR will have begin_code = 01 and end_code = 03). |
reference_period_desc |
"Period" - The specific time frame, within a freq_desc. |
week_ending |
Week ending date, used when freq_desc = WEEKLY. |
format |
Output format from API call. Defaults to CSV as it is typically the smallest sized call. Other options are JSON and XML but these are not recommended. XML currently not supported. |
... |
Not used. |
A list containing arguments for Quick Stats API call
## Not run: args_list(year = 2012, short_desc = "AG LAND, INCL BUILDINGS - ASSET VALUE, MEASURED IN $", county_name = c("Durham", "WAKE"), state_name = "NORTH CAROLINA") ## End(Not run)## Not run: args_list(year = 2012, short_desc = "AG LAND, INCL BUILDINGS - ASSET VALUE, MEASURED IN $", county_name = c("Durham", "WAKE"), state_name = "NORTH CAROLINA") ## End(Not run)
Checks the number of observations that will be returned in a data request. All queries to the Quick Stats are limited to 50,000 observations. This is a helpful function in determining how to structure a data request to fit within the 50,000 limit.
nass_count( source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = check_key(), ... )nass_count( source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = check_key(), ... )
source_desc |
"Program" - Source of data ("CENSUS" or "SURVEY"). Census program includes the Census of Ag as well as follow up projects. Survey program includes national, state, and county surveys. |
sector_desc |
"Sector" - Five high level, broad categories useful to narrow down choices. ("ANIMALS & PRODUCTS", "CROPS", "DEMOGRAPHICS", "ECONOMICS", or "ENVIRONMENTAL") |
group_desc |
"Group" - Subsets within sector (e.g., under sector_desc = "CROPS", the groups are "FIELD CROPS", "FRUIT & TREE NUTS", "HORTICULTURE", and "VEGETABLES"). |
commodity_desc |
"Commodity" - The primary subject of interest (e.g., "CORN", "CATTLE", "LABOR", "TRACTORS", "OPERATORS"). |
class_desc |
Generally a physical attribute (e.g., variety, size, color, gender) of the commodity. |
prodn_practice_desc |
A method of production or action taken on the commodity (e.g., IRRIGATED, ORGANIC, ON FEED). |
util_practice_desc |
Utilizations (e.g., GRAIN, FROZEN, SLAUGHTER) or marketing channels (e.g., FRESH MARKET, PROCESSING, RETAIL). |
statisticcat_desc |
"Category" - The aspect of a commodity being measured (e.g., "AREA HARVESTED", "PRICE RECEIVED", "INVENTORY", "SALES"). |
unit_desc |
The unit associated with the statistic category (e.g., ACRES, $ / LB, HEAD, $, OPERATIONS). |
short_desc |
"Data Item" - A concatenation of six columns: commodity_desc, class_desc, prodn_practice_desc, util_practice_desc, statisticcat_desc, and unit_desc. |
domain_desc |
"Domain" - Generally another characteristic of operations that produce a particular commodity (e.g., "ECONOMIC CLASS", "AREA OPERATED", "NAICS CLASSIFICATION", "SALES"). For chemical usage data, the domain describes the type of chemical applied to the commodity. The domain_desc = "TOTAL" will have no further breakouts; i.e., the data value pertains completely to the short_desc. |
domaincat_desc |
"Domain Category" - Categories or partitions within a domain (e.g., under domain_desc = "SALES", domain categories include $1,000 TO $9,999, $10,000 TO $19,999, etc). |
agg_level_desc |
"Geographic Level" - Aggregation level or geographic granularity of the data. ("AGRICULTURAL DISTRICT", "COUNTY", "INTERNATIONAL", "NATIONAL", "REGION : MULTI-STATE", "REGION : SUB-STATE", "STATE", "WATERSHED", or "ZIP CODE") |
state_ansi |
American National Standards Institute (ANSI) standard 2-digit state codes. |
state_fips_code |
NASS 2-digit state codes; include 99 and 98 for US TOTAL and OTHER STATES, respectively; otherwise match ANSI codes. |
state_alpha |
State abbreviation, 2-character alpha code. |
state_name |
"State" - State full name. |
asd_code |
NASS defined county groups, unique within a state, 2-digit ag statistics district code. |
asd_desc |
"Ag District" - Ag statistics district name. |
county_ansi |
ANSI standard 3-digit county codes. |
county_code |
NASS 3-digit county codes; includes 998 for OTHER (COMBINED) COUNTIES and Alaska county codes; otherwise match ANSI codes. |
county_name |
"County" - County name. |
region_desc |
"Region" - NASS defined geographic entities not readily defined by other standard geographic levels. A region can be a less than a state (SUB-STATE) or a group of states (MULTI-STATE), and may be specific to a commodity. |
zip_5 |
"Zip Code" - US Postal Service 5-digit zip code. |
watershed_code |
US Geological Survey (USGS) 8-digit Hydrologic Unit Code (HUC) for watersheds. |
watershed_desc |
"Watershed" - Name assigned to the HUC. |
congr_district_code |
US Congressional District 2-digit code. |
country_code |
US Census Bureau, Foreign Trade Division 4-digit country code, as of April, 2007. |
country_name |
Country name. |
location_desc |
Full description for the location dimension. |
year |
"Year" - The numeric year of the data and can be either a character or numeric vector. Conditional values are also possible, for example a character vector of ">=1999" of "1999<=" will give years greater than or equal to 1999. Right now the logical values can either be greater/less than or equal to with the logical at either the beginning or end of a string with the year. |
freq_desc |
"Period Type" - Length of time covered ("ANNUAL", "SEASON", "MONTHLY", "WEEKLY", "POINT IN TIME"). "MONTHLY" often covers more than one month. "POINT IN TIME" is as of a particular day. |
begin_code |
If applicable, a 2-digit code corresponding to the beginning of the reference period (e.g., for freq_desc = MONTHLY, begin_code ranges from 01 (January) to 12 (December)). |
end_code |
If applicable, a 2-digit code corresponding to the end of the reference period (e.g., the reference period of JAN THRU MAR will have begin_code = 01 and end_code = 03). |
reference_period_desc |
"Period" - The specific time frame, within a freq_desc. |
week_ending |
Week ending date, used when freq_desc = WEEKLY. |
key |
API key, default is to use the value stored in |
... |
Not used. |
Number of observations.
## Not run: # Determine all the observations in NASS nass_count() ## End(Not run) ## Not run: # Find the number of observations for Wake County in North Carolina nass_count(state_name = "NORTH CAROLINA", county_name = "WAKE") ## End(Not run)## Not run: # Determine all the observations in NASS nass_count() ## End(Not run) ## Not run: # Find the number of observations for Wake County in North Carolina nass_count(state_name = "NORTH CAROLINA", county_name = "WAKE") ## End(Not run)
Sends query to Quick Stats API from given parameter values. Data
request is limited to 50,000 records per the API. Use
nass_count to determine number of records in query.
nass_data( source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = NULL, format = c("CSV", "JSON", "XML"), numeric_vals = FALSE )nass_data( source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = NULL, format = c("CSV", "JSON", "XML"), numeric_vals = FALSE )
source_desc |
"Program" - Source of data ("CENSUS" or "SURVEY"). Census program includes the Census of Ag as well as follow up projects. Survey program includes national, state, and county surveys. |
sector_desc |
"Sector" - Five high level, broad categories useful to narrow down choices. ("ANIMALS & PRODUCTS", "CROPS", "DEMOGRAPHICS", "ECONOMICS", or "ENVIRONMENTAL") |
group_desc |
"Group" - Subsets within sector (e.g., under sector_desc = "CROPS", the groups are "FIELD CROPS", "FRUIT & TREE NUTS", "HORTICULTURE", and "VEGETABLES"). |
commodity_desc |
"Commodity" - The primary subject of interest (e.g., "CORN", "CATTLE", "LABOR", "TRACTORS", "OPERATORS"). |
class_desc |
Generally a physical attribute (e.g., variety, size, color, gender) of the commodity. |
prodn_practice_desc |
A method of production or action taken on the commodity (e.g., IRRIGATED, ORGANIC, ON FEED). |
util_practice_desc |
Utilizations (e.g., GRAIN, FROZEN, SLAUGHTER) or marketing channels (e.g., FRESH MARKET, PROCESSING, RETAIL). |
statisticcat_desc |
"Category" - The aspect of a commodity being measured (e.g., "AREA HARVESTED", "PRICE RECEIVED", "INVENTORY", "SALES"). |
unit_desc |
The unit associated with the statistic category (e.g., ACRES, $ / LB, HEAD, $, OPERATIONS). |
short_desc |
"Data Item" - A concatenation of six columns: commodity_desc, class_desc, prodn_practice_desc, util_practice_desc, statisticcat_desc, and unit_desc. |
domain_desc |
"Domain" - Generally another characteristic of operations that produce a particular commodity (e.g., "ECONOMIC CLASS", "AREA OPERATED", "NAICS CLASSIFICATION", "SALES"). For chemical usage data, the domain describes the type of chemical applied to the commodity. The domain_desc = "TOTAL" will have no further breakouts; i.e., the data value pertains completely to the short_desc. |
domaincat_desc |
"Domain Category" - Categories or partitions within a domain (e.g., under domain_desc = "SALES", domain categories include $1,000 TO $9,999, $10,000 TO $19,999, etc). |
agg_level_desc |
"Geographic Level" - Aggregation level or geographic granularity of the data. ("AGRICULTURAL DISTRICT", "COUNTY", "INTERNATIONAL", "NATIONAL", "REGION : MULTI-STATE", "REGION : SUB-STATE", "STATE", "WATERSHED", or "ZIP CODE") |
state_ansi |
American National Standards Institute (ANSI) standard 2-digit state codes. |
state_fips_code |
NASS 2-digit state codes; include 99 and 98 for US TOTAL and OTHER STATES, respectively; otherwise match ANSI codes. |
state_alpha |
State abbreviation, 2-character alpha code. |
state_name |
"State" - State full name. |
asd_code |
NASS defined county groups, unique within a state, 2-digit ag statistics district code. |
asd_desc |
"Ag District" - Ag statistics district name. |
county_ansi |
ANSI standard 3-digit county codes. |
county_code |
NASS 3-digit county codes; includes 998 for OTHER (COMBINED) COUNTIES and Alaska county codes; otherwise match ANSI codes. |
county_name |
"County" - County name. |
region_desc |
"Region" - NASS defined geographic entities not readily defined by other standard geographic levels. A region can be a less than a state (SUB-STATE) or a group of states (MULTI-STATE), and may be specific to a commodity. |
zip_5 |
"Zip Code" - US Postal Service 5-digit zip code. |
watershed_code |
US Geological Survey (USGS) 8-digit Hydrologic Unit Code (HUC) for watersheds. |
watershed_desc |
"Watershed" - Name assigned to the HUC. |
congr_district_code |
US Congressional District 2-digit code. |
country_code |
US Census Bureau, Foreign Trade Division 4-digit country code, as of April, 2007. |
country_name |
Country name. |
location_desc |
Full description for the location dimension. |
year |
"Year" - The numeric year of the data and can be either a character or numeric vector. Conditional values are also possible, for example a character vector of ">=1999" of "1999<=" will give years greater than or equal to 1999. Right now the logical values can either be greater/less than or equal to with the logical at either the beginning or end of a string with the year. |
freq_desc |
"Period Type" - Length of time covered ("ANNUAL", "SEASON", "MONTHLY", "WEEKLY", "POINT IN TIME"). "MONTHLY" often covers more than one month. "POINT IN TIME" is as of a particular day. |
begin_code |
If applicable, a 2-digit code corresponding to the beginning of the reference period (e.g., for freq_desc = MONTHLY, begin_code ranges from 01 (January) to 12 (December)). |
end_code |
If applicable, a 2-digit code corresponding to the end of the reference period (e.g., the reference period of JAN THRU MAR will have begin_code = 01 and end_code = 03). |
reference_period_desc |
"Period" - The specific time frame, within a freq_desc. |
week_ending |
Week ending date, used when freq_desc = WEEKLY. |
key |
API key, default is to use the value stored in |
format |
Output format from API call. Defaults to CSV as it is typically the smallest sized call. Other options are JSON and XML but these are not recommended. XML currently not supported. |
numeric_vals |
Optional to convert the year, Value, and coefficient of variation (CV %) to numerics as opposed to defaulted character values. Default is to FALSE as some Values have a suppression code. Converting to numeric will result in suppressed values to be NA. |
A data frame containing query to API.
## Not run: # Get state values in 2012 for all of the values of agricultural land nass_data(agg_level_desc = "STATE", year = "2012", commodity_desc = "AG LAND", domain_desc = "VALUE") ## End(Not run) ## Not run: # Get county level values in 2012 for the specific data item nass_data(year = 2012, agg_level_desc = "COUNTY", short_desc = "AG LAND, INCL BUILDINGS - ASSET VALUE, MEASURED IN $") ## End(Not run)## Not run: # Get state values in 2012 for all of the values of agricultural land nass_data(agg_level_desc = "STATE", year = "2012", commodity_desc = "AG LAND", domain_desc = "VALUE") ## End(Not run) ## Not run: # Get county level values in 2012 for the specific data item nass_data(year = 2012, agg_level_desc = "COUNTY", short_desc = "AG LAND, INCL BUILDINGS - ASSET VALUE, MEASURED IN $") ## End(Not run)
All possible values of a parameter for a given query. Helps to
understand the columns of data.frame from nass_data.
nass_param( param = NULL, source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = NULL )nass_param( param = NULL, source_desc = NULL, sector_desc = NULL, group_desc = NULL, commodity_desc = NULL, class_desc = NULL, prodn_practice_desc = NULL, util_practice_desc = NULL, statisticcat_desc = NULL, unit_desc = NULL, short_desc = NULL, domain_desc = NULL, domaincat_desc = NULL, agg_level_desc = NULL, state_ansi = NULL, state_fips_code = NULL, state_alpha = NULL, state_name = NULL, asd_code = NULL, asd_desc = NULL, county_ansi = NULL, county_code = NULL, county_name = NULL, region_desc = NULL, zip_5 = NULL, watershed_code = NULL, watershed_desc = NULL, congr_district_code = NULL, country_code = NULL, country_name = NULL, location_desc = NULL, year = NULL, freq_desc = NULL, begin_code = NULL, end_code = NULL, reference_period_desc = NULL, week_ending = NULL, key = NULL )
param |
A valid parameter value. Available names are: source_desc, sector_desc, group_desc, commodity_desc, short_desc, domain_desc, domaincat_desc, agg_level_desc, statisticcat_desc, state_name, asd_desc, county_name, region_desc, zip_5, watershed_desc, year, freq_desc, and reference_period_desc. |
source_desc |
"Program" - Source of data ("CENSUS" or "SURVEY"). Census program includes the Census of Ag as well as follow up projects. Survey program includes national, state, and county surveys. |
sector_desc |
"Sector" - Five high level, broad categories useful to narrow down choices. ("ANIMALS & PRODUCTS", "CROPS", "DEMOGRAPHICS", "ECONOMICS", or "ENVIRONMENTAL") |
group_desc |
"Group" - Subsets within sector (e.g., under sector_desc = "CROPS", the groups are "FIELD CROPS", "FRUIT & TREE NUTS", "HORTICULTURE", and "VEGETABLES"). |
commodity_desc |
"Commodity" - The primary subject of interest (e.g., "CORN", "CATTLE", "LABOR", "TRACTORS", "OPERATORS"). |
class_desc |
Generally a physical attribute (e.g., variety, size, color, gender) of the commodity. |
prodn_practice_desc |
A method of production or action taken on the commodity (e.g., IRRIGATED, ORGANIC, ON FEED). |
util_practice_desc |
Utilizations (e.g., GRAIN, FROZEN, SLAUGHTER) or marketing channels (e.g., FRESH MARKET, PROCESSING, RETAIL). |
statisticcat_desc |
"Category" - The aspect of a commodity being measured (e.g., "AREA HARVESTED", "PRICE RECEIVED", "INVENTORY", "SALES"). |
unit_desc |
The unit associated with the statistic category (e.g., ACRES, $ / LB, HEAD, $, OPERATIONS). |
short_desc |
"Data Item" - A concatenation of six columns: commodity_desc, class_desc, prodn_practice_desc, util_practice_desc, statisticcat_desc, and unit_desc. |
domain_desc |
"Domain" - Generally another characteristic of operations that produce a particular commodity (e.g., "ECONOMIC CLASS", "AREA OPERATED", "NAICS CLASSIFICATION", "SALES"). For chemical usage data, the domain describes the type of chemical applied to the commodity. The domain_desc = "TOTAL" will have no further breakouts; i.e., the data value pertains completely to the short_desc. |
domaincat_desc |
"Domain Category" - Categories or partitions within a domain (e.g., under domain_desc = "SALES", domain categories include $1,000 TO $9,999, $10,000 TO $19,999, etc). |
agg_level_desc |
"Geographic Level" - Aggregation level or geographic granularity of the data. ("AGRICULTURAL DISTRICT", "COUNTY", "INTERNATIONAL", "NATIONAL", "REGION : MULTI-STATE", "REGION : SUB-STATE", "STATE", "WATERSHED", or "ZIP CODE") |
state_ansi |
American National Standards Institute (ANSI) standard 2-digit state codes. |
state_fips_code |
NASS 2-digit state codes; include 99 and 98 for US TOTAL and OTHER STATES, respectively; otherwise match ANSI codes. |
state_alpha |
State abbreviation, 2-character alpha code. |
state_name |
"State" - State full name. |
asd_code |
NASS defined county groups, unique within a state, 2-digit ag statistics district code. |
asd_desc |
"Ag District" - Ag statistics district name. |
county_ansi |
ANSI standard 3-digit county codes. |
county_code |
NASS 3-digit county codes; includes 998 for OTHER (COMBINED) COUNTIES and Alaska county codes; otherwise match ANSI codes. |
county_name |
"County" - County name. |
region_desc |
"Region" - NASS defined geographic entities not readily defined by other standard geographic levels. A region can be a less than a state (SUB-STATE) or a group of states (MULTI-STATE), and may be specific to a commodity. |
zip_5 |
"Zip Code" - US Postal Service 5-digit zip code. |
watershed_code |
US Geological Survey (USGS) 8-digit Hydrologic Unit Code (HUC) for watersheds. |
watershed_desc |
"Watershed" - Name assigned to the HUC. |
congr_district_code |
US Congressional District 2-digit code. |
country_code |
US Census Bureau, Foreign Trade Division 4-digit country code, as of April, 2007. |
country_name |
Country name. |
location_desc |
Full description for the location dimension. |
year |
"Year" - The numeric year of the data and can be either a character or numeric vector. Conditional values are also possible, for example a character vector of ">=1999" of "1999<=" will give years greater than or equal to 1999. Right now the logical values can either be greater/less than or equal to with the logical at either the beginning or end of a string with the year. |
freq_desc |
"Period Type" - Length of time covered ("ANNUAL", "SEASON", "MONTHLY", "WEEKLY", "POINT IN TIME"). "MONTHLY" often covers more than one month. "POINT IN TIME" is as of a particular day. |
begin_code |
If applicable, a 2-digit code corresponding to the beginning of the reference period (e.g., for freq_desc = MONTHLY, begin_code ranges from 01 (January) to 12 (December)). |
end_code |
If applicable, a 2-digit code corresponding to the end of the reference period (e.g., the reference period of JAN THRU MAR will have begin_code = 01 and end_code = 03). |
reference_period_desc |
"Period" - The specific time frame, within a freq_desc. |
week_ending |
Week ending date, used when freq_desc = WEEKLY. |
key |
API key, default is to use the value stored in |
Character vector of all possible parameter values.
## Not run: # Return the program sources for data nass_param("source_desc") ## End(Not run) ## Not run: # Return the group categories available in the CROPS sector nass_param("group_desc", sector_desc = "CROPS") ## End(Not run)## Not run: # Return the program sources for data nass_param("source_desc") ## End(Not run) ## Not run: # Return the group categories available in the CROPS sector nass_param("group_desc", sector_desc = "CROPS") ## End(Not run)
This function will add your Quick Stats API key to your
.Renviron file so it can be called securely without being stored in
your code. After you have installed your key, it can be called any time by
typing Sys.getenv("NASS_KEY") and can be used in package functions
by simply typing NASS_KEY. If you do not have an .Renviron file, the
function will create on for you. If you already have an .Renviron
file, the function will append the key to your existing file, while making
a backup of your original file for disaster recovery purposes.
nass_set_key(key = NULL, overwrite = FALSE)nass_set_key(key = NULL, overwrite = FALSE)
key |
The API key provided to you from NASS formatted in quotes. A key can be acquired at https://quickstats.nass.usda.gov/api |
overwrite |
If this is set to TRUE, it will write an existing
NASS_KEY that you already have in your |
## Not run: set_nass_key("abcd012345678901234567890123456789") # First time, relead your enviornment so you can use the key without # restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("NASS_KEY") ## End(Not run) ## Not run: # If you need to overwrite an existing key: nass_set_key("abcd012345678901234567890123456789", overwrite = TRUE) # First time, relead your enviornment so you can use the key without # restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("NASS_KEY") ## End(Not run)## Not run: set_nass_key("abcd012345678901234567890123456789") # First time, relead your enviornment so you can use the key without # restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("NASS_KEY") ## End(Not run) ## Not run: # If you need to overwrite an existing key: nass_set_key("abcd012345678901234567890123456789", overwrite = TRUE) # First time, relead your enviornment so you can use the key without # restarting R. readRenviron("~/.Renviron") # You can check it with: Sys.getenv("NASS_KEY") ## End(Not run)