| Title: | Utility Functions for Forest Inventory Estimation and Analysis |
|---|---|
| Description: | A set of tools for data wrangling, spatial data analysis, statistical modeling (including direct, model-assisted, photo-based, and small area tools), and USDA Forest Service data base tools. These tools are aimed to help Foresters, Analysts, and Scientists extract and perform analyses on USDA Forest Service data. |
| Authors: | Tracey Frescino [aut], Chris Toney [aut], Grayson White [aut, cre], Joshua Yamamoto [aut] |
| Maintainer: | Grayson White <[email protected]> |
| License: | GPL-3 |
| Version: | 1.2.3.9000 |
| Built: | 2024-09-18 04:19:05 UTC |
| Source: | https://github.com/usdaforestservice/fiestautils |
Updates reference tables
.update_refs(write = FALSE).update_refs(write = FALSE)
write |
Logical. Should the internal reference tables be overwritten? |
No return value. Called for side effects.
Josh Yamamoto
Exports a data frame object to a specified output.
datExportData( dfobj, create_dsn = FALSE, index.unique = NULL, index = NULL, savedata_opts = savedata_options(), dbconn = NULL, dbconnopen = FALSE )datExportData( dfobj, create_dsn = FALSE, index.unique = NULL, index = NULL, savedata_opts = savedata_options(), dbconn = NULL, dbconnopen = FALSE )
dfobj |
Data.frame class R object. Data frame object to export. |
create_dsn |
Boolean. |
index.unique |
String. Name of variable(s) in dfobj to make unique index. |
index |
String. Name of variable(s) in dfobj to make (non-unique) index. dbconnopen Logical. If TRUE, keep database connection open. |
savedata_opts |
List. See help(savedata_options()) for a list of options. |
dbconn |
Open database connection. |
dbconnopen |
Logical. If TRUE, keep database connection open. |
Wrapper for sf::st_write function.
An sf spatial object is written to the out_dsn.
If out_fmt='shp':
The ESRI shapefile driver truncates variable
names to 10 characters or less. Variable names are changed before export
using an internal function (trunc10shp). Name changes are output to the
outfolder, 'outshpnm'_newnames.csv.
If sf object has more than 1 record, it cannot be exported to a shapefile.
Tracey S. Frescino
Checks a PostgreSQL database.
DBtestPostgreSQL( dbname = NULL, host = NULL, port = NULL, user = NULL, password = NULL, dbconnopen = FALSE, showlist = TRUE, ... )DBtestPostgreSQL( dbname = NULL, host = NULL, port = NULL, user = NULL, password = NULL, dbconnopen = FALSE, showlist = TRUE, ... )
dbname |
String. Name of the database on the host. |
host |
String. Host name. |
port |
String. Port number. |
user |
String. User name. |
password |
String. Password. |
dbconnopen |
Logical. If TRUE, the database connection is returned and not closed. |
showlist |
Logical. If TRUE, prints list of tables in database. |
... |
Additional authentication arguments passed to DBI::dbConnect |
An S4 object that inherits from DBIConnection via the DBI package if dbconnopen = TRUE, or NULL otherwise. For more information, see 'help(DBI::dbConnect)'.
Tracey S. Frescino
Checks a SQLite database.
DBtestSQLite( SQLitefn = NULL, gpkg = FALSE, dbconnopen = FALSE, outfolder = NULL, showlist = TRUE, returnpath = TRUE, createnew = TRUE, stopifnull = FALSE, overwrite = TRUE )DBtestSQLite( SQLitefn = NULL, gpkg = FALSE, dbconnopen = FALSE, outfolder = NULL, showlist = TRUE, returnpath = TRUE, createnew = TRUE, stopifnull = FALSE, overwrite = TRUE )
SQLitefn |
String. Name of SQLite database (*.sqlite). |
gpkg |
Logical. If TRUE, Sqlite geopackage database. |
dbconnopen |
Logical. If TRUE, the dbconn connection is not closed. |
outfolder |
String. Optional. Name of output folder. If NULL, export to working directory. |
showlist |
Logical. If TRUE, shows list of tables in database. |
returnpath |
Logical. If TRUE, returns full path to SQLite file name. If FALSE, returns SQLitefn. |
createnew |
If TRUE, creates new SQLite database. |
stopifnull |
Logical. If TRUE, stops if SQLite database doesn't exist. |
overwrite |
Logical. If TRUE, overwrites data. |
Character string containing the path to the SQLite database of interest.
Tracey S. Frescino
Returns a list of user-supplied parameters and parameter values for data evaluation (FIA or custom) extraction to be supplied to *DB functions.
eval_options( Cur = FALSE, Endyr = NULL, Endyr.filter = NULL, All = FALSE, Type = "VOL", evalid = NULL, invyrs = NULL, measyrs = NULL, varCur = "INVYR", evalType = NULL, ... )eval_options( Cur = FALSE, Endyr = NULL, Endyr.filter = NULL, All = FALSE, Type = "VOL", evalid = NULL, invyrs = NULL, measyrs = NULL, varCur = "INVYR", evalType = NULL, ... )
Cur |
Logical. If eval='FIA': extract plots with most current evaluation. If eval='custom': extract the most current sampled plots in the database. |
Endyr |
Integer (YYYY). If eval='FIA', defines end year for extracting one or more FIA evaluation. If eval='custom', defines end year for extracting the most current sampled plots until. |
Endyr.filter |
Filter. If endyr != NULL, a filter to identify when to use measEndyr, such as areas or plots identified as being disturbed in a particular year. In this example, plots sampled after the disturbance will be excluded. |
All |
Logical. If eval='FIA': includes all evaluations in database (annual inventory only). If eval='custom': includes all years in database (annual inventory only). |
Type |
String vector. Evaluation types ('ALL','CURR','VOL','P2VEG', DWM','INV','CHNG','GRM','REGEN'). If eval='FIA', Type is equivalent to plots for FIA Evaluations where 'ALL' includes nonsampled plots; 'CURR' and 'VOL' include plots used for area or tree estimates, respectively; Type = 'GRM' includes plots used for growth, removals, mortality; and Type = 'CHNG' includes plots used for change estimates (See FIA database manual for regioin availability and/or differences (https://www.fia.fs.usda.gov/library/database-documentation/index.php) If eval='custom', the associated tables are extracted for each Type. Multiple Types are accepted. |
evalid |
Integer. Only eval='FIA': extract data for a specific evaluation period. See notes for more information about FIA Evaluations. |
invyrs |
Integer vector. eval='custom': defines specific inventory years of data (e.g., 2010:2015). See FIA manual for definition of INVYR. |
measyrs |
Integer vector. eval='custom': defines specific measurement years of data (e.g., 2010:2015). |
varCur |
String. Name of variable to use for most current plot ('MEASYEAR', 'INVYR'). |
evalType |
Deprecated. Use Type instead. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for strata.
Tracey S. Frescino
eval_options(invyrs = 2015:2018)eval_options(invyrs = 2015:2018)
Table with gdal data type names.
A vector of 12 data type values.
gdal values.
Table with variable codes (VALUE) and descriptions (MEANING).
A dataframe
FIA query. SELECT bp.STATECD, bp.COUNTYCD, bp.PLOT_FIADB NEW_PLOT, bp.START_DATE NEW_START_DATE, bp_old.COUNTYCD OLD_COUNTYCD, bp_old.PLOT_FIADB OLD_PLOT, bp_old.END_DATE OLD_END_DATE, p.CN FROM fs_nims_rmrs.NIMS_BASE_PLOT bp JOIN fs_nims_rmrs.NIMS_BASE_PLOT bp_old on (bp.PREV_NBP_CN=bp_old.CN) JOIN fs_nims_rmrs.NIMS_PLOT_RMRS_VW p on(p.NBP_CN=bp_old.CN) WHERE p.KINDCD = 1 ORDER BY bp.STATECD, bp.COUNTYCD, bp_old.PLOT_FIADB"
Returns a list of user-supplied parameters and parameter values for outputting multest with custom aesthetics.
multest_options( multest_fmt = "csv", multest_outfolder = NULL, multest_dsn = NULL, multest_layer = NULL, multest.append = FALSE, multest.AOIonly = FALSE, ... )multest_options( multest_fmt = "csv", multest_outfolder = NULL, multest_dsn = NULL, multest_layer = NULL, multest.append = FALSE, multest.AOIonly = FALSE, ... )
multest_fmt |
String. Format for multest output tables ('csv', 'sqlite', 'gpkg'). |
multest_outfolder |
String. Outfolder for multest. If NULL, same as outfolder. |
multest_dsn |
String. Name of database if multest_fmt = c('sqlite', 'gpkg'). |
multest_layer |
String. Name of database layer if multest_fmt = c('sqlite', 'gpkg'). |
multest.append |
Logical. If TRUE, appends multest dataframe to output. |
multest.AOIonly |
Logical. If TRUE, appends multest dataframe (AOI=1) to output. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for outputting multest.
Grayson W. White
multest_options(multest.append = TRUE)multest_options(multest.append = TRUE)
"Rcpp_CmbTable"
C++ program to combine raster files.
Class "C++Object", directly.
All reference classes extend and inherit methods from
"envRefClass".
Chris Toney
"Rcpp_RunningStats"
C++ program to calculate mean and variance on a data stream.
Class "C++Object", directly.
All reference classes extend and inherit methods from
"envRefClass".
Chris Toney
Table with variable codes (VALUE) and descriptions (MEANING).
A dataframe with 7 columns, VARIABLE, VALUE, MEANING, COLORHEX, GROUP, GROUPNM, GROUPHEX.
FIA look-up tables.
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with variable codes (VALUE) and descriptions (MEANING).
A dataframe with 7 columns, VARIABLE, VALUE, MEANING, COLORHEX, GROUP, GROUPNM, GROUPHEX.
FIA look-up tables.
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Data frame with variable names and descriptions
A data frame with 61 rows and 3 columns VARIABLE - Variable in cond data frame DESCRIPTION - Description of variable in cond data frame TABLE - Table in database where variable originates or if derived
FIA look-up table
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with conversion factors from English to metric units.
A dataframe with 6 columns: TYPE, ENGLISH, ENGLISH_ABBR, METRIC, METRIC_ABBR, CONVERSION.
Conversion table.
Table with min (MIN), max (MAX), and 2-inch class diameter codes (MEANING).
A dataframe with 3 columns, MIN, MAX, and MEANING.
Imported from comma-delimited file.
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with row/column domain (VARNM) and their pretty names for table output (TABLENM).
A dataframe with 2 columns, VARNM and TABLENM.
FIA look-up table.
Data frame with variable names and descriptions
A data frame to use a reference for estimation variables and filters.
Table with row/column domain (VARNM) and their pretty names for table output (TABLENM).
A dataframe with 3 columns, EVAL_TYP_CD, EVAL_TYP, DESCRIPTION.
FIA look-up table.
Data frame with variable names and descriptions.
A data frame with 43 rows and 3 columns VARIABLE - Variable in plt data frame DESCRIPTION - Description of variable in plt data frame TABLE - Table in database where variable originates or if derived
FIA look-up table
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with population type (popType) and associated evaluation code (EVAL_TYP_CD).
A dataframe with 2 columns, VARNM and TITLE.
Comma-delimited file.
Data frame with variable names and descriptions
A dataframe with 63 rows and 4 columns VARIABLE - Variable in plt data frame DESCRIPTION - Description of variable in plt data frame TABLE - Table in database where variable originates or if derived SHPEXPORT - Name of variable for exported shapefile (<= 10 characters)
FIA look-up table
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with species information downloaded from datamart FIADB_REFERENCES, subset from REF_SPECIES TABLE.
A dataframe with 14 columns: SPCD, COMMON_NAME, GENUS, SPECIES, SPECIES_SYMBOL, E_SPGRCD, W_SPGRPCD, C_SPGRPCD, P_SPGRPCD, MAJOR_SPGRPCD, JENKINS_TOTAL_B1, JENKINS_TOTAL_B2, DRYWT_TO_GREENWT_CONERSION, SCIENTIFIC_NAME (GENUS + SPECIES).
Imported from comma-delimited file.
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with state codes (VALUE), name (MEANING), abbreviation (ABBR), and UNIT.
A dataframe with 4 columns, VALUE, MEANING, ABBR, UNIT.
Imported from comma-delimited file.
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with variable name (VARNM) and associated title (TITLE).
A dataframe with 2 columns, VARNM and TITLE.
Comma-delimited file.
Data frame with variable names and descriptions
A data frame with 72 rows and 3 columns VARIABLE - Variable in tree data frame DESCRIPTION - Description of variable in tree data frame TABLE - Table in database where variable originates
FIA look-up table
O'Connell, B.M.; LaPoint, E.B.; Turner, J.A.; Ridley, T.; Boyer, D.; Wilson, A.M.; Waddell, K.L.; Christensen, G.; Conkling, B.L. 2012. The Forest Inventory and Analysis Database: Database Description and Users Manual Version 5.1.2 for Phase 2. U.S. Department of Agriculture. (http://fia.fs.fed.us/library/database-documentation/current/ver5-2012/FIADB_user manual_5-1-2_p2_07_2012.pdf)
Table with units for TREE variables. The WOODLAND column was added to identify which variables include woodland species.The kg2tons column was added to identify which variables are commonly converted from kilograms to tons in estimation process.
A dataframe with 4 columns: VARIABLE, UNITS, METRICUNITS, WOODLAND, kg2tons.
Units table.
Returns a list of user-supplied parameters and parameter values for saving data.
savedata_options( outfolder = NULL, out_fmt = "csv", outsp_fmt = "shp", outobj_fmt = "rds", out_dsn = NULL, out_layer = "outdat", outfn.pre = NULL, outfn.date = FALSE, addtitle = TRUE, raw_fmt = "csv", raw_dsn = NULL, overwrite_dsn = FALSE, overwrite_layer = TRUE, append_layer = FALSE, add_layer = TRUE, layer.pre = NULL, outconn = NULL, ... )savedata_options( outfolder = NULL, out_fmt = "csv", outsp_fmt = "shp", outobj_fmt = "rds", out_dsn = NULL, out_layer = "outdat", outfn.pre = NULL, outfn.date = FALSE, addtitle = TRUE, raw_fmt = "csv", raw_dsn = NULL, overwrite_dsn = FALSE, overwrite_layer = TRUE, append_layer = FALSE, add_layer = TRUE, layer.pre = NULL, outconn = NULL, ... )
outfolder |
String. The outfolder to write files to. If NULL, files are written to working directory, or if gui=TRUE, a window to browse. |
out_fmt |
String. Format for output tables ('csv', 'sqlite', 'gpkg', 'gdb'). |
outsp_fmt |
String. Format for output spatial ('shp', sqlite', 'gpkg', 'gdb'). |
outobj_fmt |
String. Format for output spatial ('rda', 'rds', 'llo'). |
out_dsn |
String. Data source name for output. If extension is not included, out_fmt is used. Use full path if outfolder=NULL. |
out_layer |
outlayer. |
outfn.pre |
String. If savedata=TRUE, prefix for output files. If rawdata=TRUE, prefix for rawdata files (if raw_fmt = 'csv') or raw_dsn (if raw_fmt != 'csv'). |
outfn.date |
Logical. If TRUE, add current date to out_dsn. |
addtitle |
Logical. If TRUE and savedata=TRUE, adds title to outfile. |
raw_fmt |
String. Format for output rawdata tables ('sqlite', 'gpkg', 'csv', 'gdb'). |
raw_dsn |
String. Data source name for rawdata output. If extension is not included, out_fmt is used. Use full path if outfolder=NULL. |
overwrite_dsn |
Logical. If TRUE, overwrites raw_dsn, if exists. |
overwrite_layer |
Logical. If TRUE, overwrites the output. If rawdata=TRUE, overwrites out_layer in rawdata folder (if raw_fmt = 'csv') or out_layers in raw_dsn (if raw_fmt != 'csv'). |
append_layer |
Logical. If TRUE, and appends data to existing *.csv files (if *_fmt = 'csv') or *_dsn layers (if *_fmt != 'csv". |
add_layer |
Logical. If TRUE, adds layer to an existing out_dsn (if out_fmt != c('csv','shp')). |
layer.pre |
Layer prefix. |
outconn |
Open database connection to save to. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for saving data.
Grayson W. White
savedata_options(outfolder = "path", overwrite_dsn = FALSE)savedata_options(outfolder = "path", overwrite_dsn = FALSE)
Returns a list of user-supplied parameters and parameter values for making SpatialPoints.
spMakeSpatial_options( xvar = NULL, yvar = NULL, xy.crs = 4269, prj = NULL, datum = NULL, zone = NULL, zoneS = FALSE, aea.param = "USGS", ... )spMakeSpatial_options( xvar = NULL, yvar = NULL, xy.crs = 4269, prj = NULL, datum = NULL, zone = NULL, zoneS = FALSE, aea.param = "USGS", ... )
xvar |
String. Name of variable in xyplt defining x coordinate. |
yvar |
String. Name of variable in xyplt defining y coordinate. |
xy.crs |
PROJ.4 String or CRS object or Integer EPSG code defining Coordinate Reference System. (e.g., EPSG:4269-Geodetic coordinate system for North America, NAD83). |
prj |
String. Projection, or coordinate system of the X/Y coordinates ("longlat", "utm", "aea"). If other, include PROJ.4 string in prj4str. |
datum |
String. Datum of projection ("WGS84", "NAD83", "NAD27"). |
zone |
Integer. If prj="utm", the UTM zone. |
zoneS |
Logical. If prj="utm", if the UTM zone is in the Southern hemisphere. |
aea.param |
String. If prj="aea", the associated lat/lon parameters (USGS: " +lat_1=29.5 +lat_2=45.5 +lat_0=23 +lon_0=-96 +x_0=0 +y_0=0"). If other, include PROJ.4 string in prj4str. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for strata.
Grayson W. White
spMakeSpatial_options()spMakeSpatial_options()
Returns a list of user-supplied parameters and parameter values for strata.
strata_options( getwt = FALSE, getwtvar = "P1POINTCNT", strwtvar = "strwt", stratcombine = TRUE, minplotnum.strat = 2, pivot = FALSE, nonresp = FALSE, ... )strata_options( getwt = FALSE, getwtvar = "P1POINTCNT", strwtvar = "strwt", stratcombine = TRUE, minplotnum.strat = 2, pivot = FALSE, nonresp = FALSE, ... )
getwt |
Logical. If TRUE, calculates strata weights from stratatlut getwtvar. If FALSE, strwtvar variable must be in stratalut. |
getwtvar |
String. If getwt=TRUE, name of variable in stratalut to calculate weights (Default = 'P1POINTCNT'). |
strwtvar |
String. If getwt=FALSE, name of variable in stratalut with calculated weights (Default = 'strwt'). |
stratcombine |
Logical. If TRUE, and strata=TRUE, automatically combines strata categories if less than minplotnum.strat plots in any one stratum. See notes for more info. |
minplotnum.strat |
Integer. Minimum number of plots for a stratum within an estimation unit. |
pivot |
Logical. If TRUE, pivot stratalut. |
nonresp |
Deprecated. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for strata.
Grayson W. White
strata_options(getwt = FALSE)strata_options(getwt = FALSE)
Polygon feature class with state and county boundaries defined by Census Bureau, including Federal Information Processing Standards (FIPS) codes. The FIA Survey Unit code and name attributes (UNITCD, UNITNM) were appended to dataset, with joining columns of STATECD and COUNTYCD.
A SpatialPolygonsDataFrame with 3233 features and 8 attributes RS - FIA Research Station name RSCD - FIA Research Station code STATECD - FIPS state code STATENM - FIPS state name STATEAB - FIPS state abbreviation UNITCD - FIA survey unit code UNITNM - FIA survey unit name COUNTYCD - FIPS county code COUNTYNM - FIPS county name
Derived from cb_2018_us_county_5m. STATEFP was converted to numeric and named STATECD COUNTYFP was converted to numeric and named COUNTYCD Lookup table for FIA Research Station (REF_RESEARCH_STATION) was downloaded from FIA DataMart on 20191105 (FIADB_1.6.1.00) and joined by STATECD. A lookup table for UNITCD was created from plot data using unique STATECD, COUNTYCD, UNITCD and joined to table.
Converted to simple feature
Transformed CRS from longlat(EPSG:4269) to
Albers (EPSG:5070)
Saved to R object, with compression='xz'
Downloaded from the United States Census Bureau on 2019 November 3, format Esri Shapefile (https://www.census.gov/geographies/mapping-files/time-series/geo/carto-boundary-file.html) Projection: Geographic (GCS_North_American_1983) EPSG: 4269
Returns a list of user-supplied parameters and parameter values for outputting tables with custom aesthetics.
table_options( row.FIAname = FALSE, col.FIAname = FALSE, row.orderby = NULL, col.orderby = NULL, row.add0 = FALSE, col.add0 = FALSE, rowlut = NULL, collut = NULL, row.classify = NULL, col.classify = NULL, rawonly = FALSE, raw.keep0 = FALSE, rowgrp = FALSE, rowgrpnm = NULL, rowgrpord = NULL, totals = TRUE, allin1 = FALSE, metric = FALSE, estround = 1, pseround = 2, estnull = "--", psenull = "--", divideby = NULL, ... )table_options( row.FIAname = FALSE, col.FIAname = FALSE, row.orderby = NULL, col.orderby = NULL, row.add0 = FALSE, col.add0 = FALSE, rowlut = NULL, collut = NULL, row.classify = NULL, col.classify = NULL, rawonly = FALSE, raw.keep0 = FALSE, rowgrp = FALSE, rowgrpnm = NULL, rowgrpord = NULL, totals = TRUE, allin1 = FALSE, metric = FALSE, estround = 1, pseround = 2, estnull = "--", psenull = "--", divideby = NULL, ... )
row.FIAname |
Logical. If TRUE, retrieves default FIA reference names for rowvar located in ref_codes data frame. Names are only available for certain variables (Check sort(unique(ref_codes$VARIABLE)) for available names. If row.FIAname = TRUE and rowvar is in ref_codes, the rowvar name is used for the output table, and the rowvar code is used to sort. |
col.FIAname |
Logical. If TRUE, retrieves default FIA reference names for colvar located in ref_codes data frame. Names are only available for certain variables. Check: sort(unique(ref_codes$VARIABLE)) for available names. If col.FIAname = TRUE and rowvar is in ref_codes, the colvar name is used for the output table, and the colvar code is used to sort. |
row.orderby |
String. Optional. Name of variable to sort table rows. Both the rowvar and row.orderby variables must be included in the same input data.frame. if NULL, and row.FIAname=FALSE or rowvar is not in ref_codes, the rows are ordered by rowvar. |
col.orderby |
String. Optional. Name of variable to sort table columns. Both the colvar and col.orderby variables must be included in the same input data.frame. if NULL, and col.FIAname=FALSE or colvar is not in ref_codes, the columns are ordered by colvar. |
row.add0 |
Logical. If TRUE, include rows with 0 values to the output table. |
col.add0 |
Logical. If TRUE, include columns with 0 values to the output table. |
rowlut |
Data frame. A lookup table with variable codes and code names to include as rows of output table (See notes for more information and format). |
collut |
Data frame. A lookup table with variable codes and code names to include as columns of output table (See notes for more information and format). |
row.classify |
Data frame (if categorical) or Vector (if continuous). If clasifying categories, input a dataframe with two columns ('FROM' and 'TO'). If classifying continuous values, input a vector of class breaks for row |
col.classify |
Data frame (if categorical) or Vector (if continuous). If clasifying categories, input a dataframe with two columns ('FROM' and 'TO'). If classifying continuous values, input a vector of class breaks for column |
rawonly |
Logical. If TRUE, only rawdata are output. If dataset includes many estimation units, and only raw data tables are desired, it is more efficient to output raw data only. |
raw.keep0 |
Logical. If TRUE, keep 0 values in raw data tables. |
rowgrp |
Logical. If TRUE, appends row groups to first column of table. Only available if group category exists in ref_codes table or defined in rowgrpnm (e.g., FORTYPGRPCD, OWNGRPCD). |
rowgrpnm |
String. Name of variable for grouping rowvar. Variable must be included in same input table as rowvar. |
rowgrpord |
String. Name of variable to sort row group variable. Variable must be included in same input table as rowgrpnm. |
totals |
Logical. If TRUE, returns total estimate (mean * AREAUSED). |
allin1 |
Logical. If TRUE, both estimates and percent sample error are output in one table as: estimates (percent sample error). |
metric |
Logical. If TRUE, output if returned in metric units. |
estround |
Integer. Number of decimal places for estimates. |
pseround |
Integer. Number of decimal places for percent sampling error. |
estnull |
Number or character. The number or symbol to use to indicate 'not sampled' for estimate. |
psenull |
Number or character. The number or symbol to use to indicate 'not sampled' for percent standard error. |
divideby |
String. Conversion number for output ('hundred', 'thousand', 'million'). |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for outputting tables with custom aesthetics.
Grayson W. White
table_options(row.FIAname = TRUE, col.FIAname = TRUE)table_options(row.FIAname = TRUE, col.FIAname = TRUE)
Returns a list of user-supplied parameters and parameter values for outputting title with custom aesthetics.
title_options( title.main = NULL, title.ref = NULL, title.rowvar = NULL, title.colvar = NULL, title.unitvar = NULL, title.estvar = NULL, title.estvarn = NULL, title.filter = NULL, title.units = "acres", ... )title_options( title.main = NULL, title.ref = NULL, title.rowvar = NULL, title.colvar = NULL, title.unitvar = NULL, title.estvar = NULL, title.estvarn = NULL, title.filter = NULL, title.units = "acres", ... )
title.main |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: the complete title used for table. If title.main=NULL, the title.* parameters are used to generate title string. Note: if title.ref is not NULL, it is added to title.main. |
title.ref |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: the ending text of the table title (e.g., Nevada, 2004-2005). If NULL, = "". |
title.rowvar |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: pretty name for the row domain variable. If NULL, = rowvar. |
title.colvar |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: pretty name for the column domain variable. If NULL, = colvar. |
title.unitvar |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: pretty name for the estimation unit variable. If NULL, = unitvar. |
title.estvar |
String. TITLE: if savedata=TRUE and/or returntitle=TRUE: pretty name for the estimate variable. If NULL, title.estvar = estvar.name. |
title.estvarn |
String. TITLE: if savedata=TRUE and/or returntitle=TRUE: pretty name for the estimate variable. If NULL, title.estvar = estvar.name. |
title.filter |
String. TITLE, if savedata=TRUE and/or returntitle=TRUE: pretty name for filter(s). If title.filter=NULL, a default is generated from cfilter. If title.filter="", no title.filter is used. |
title.units |
String. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for outputting titles with custom aesthetics.
Grayson W. White
title_options(title.main = "My fancy title", title.estvar = "Estimate title")title_options(title.main = "My fancy title", title.estvar = "Estimate title")
Returns a list of user-supplied parameters and parameter values for unit.
unit_options( unitvar2 = NULL, areaunits = "acres", minplotnum.unit = 10, unit.action = "keep", npixelvar = "npixels", ... )unit_options( unitvar2 = NULL, areaunits = "acres", minplotnum.unit = 10, unit.action = "keep", npixelvar = "npixels", ... )
unitvar2 |
String. Name of a second level estimation unit variable in unitarea and cond or pltassgn with assignment for each plot (e.g., 'STATECD'). |
areaunits |
String. Units of areavar in unitarea ('acres', 'hectares'). |
minplotnum.unit |
Integer. Minimum number of plots for estimation unit. |
unit.action |
String. What to do if number of plots in an estimation unit is less than minplotnum.unit ('keep', 'remove' 'combine'). If unit.action='keep', estimation units with less that minplotnum.unit will be kept in output tables; if unit.action='remove', the estimation units with less that minplotnum.unit will be removed from the output tables; and if unit.action='combine', combines estimation unit to the following estimation unit, ordered in stratalut or unitzonal. |
npixelvar |
String. Name of variable in unitlut defining number of pixels by estimation unit. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for strata.
Grayson W. White
unit_options()unit_options()
Returns a list of user-supplied parameters and parameter values for data xyuation (FIA or custom) extraction to be supplied to *DB functions.
xy_options( xy.uniqueid = "CN", xvar = "LON", yvar = "LAT", xy.crs = 4269, xyjoinid = NULL, ... )xy_options( xy.uniqueid = "CN", xvar = "LON", yvar = "LAT", xy.crs = 4269, xyjoinid = NULL, ... )
xy.uniqueid |
String. Unique identifier of xy. |
xvar |
String. Name of variable in xy defining x coordinate. |
yvar |
String. Name of variable in xy defining y coordinate. |
xy.crs |
PROJ.4 String or CRS object or Integer EPSG code defining Coordinate Reference System. |
xyjoinid |
String. Name of variable in xy to join to plot data. If NULL, xyjoinid = xy.uniqueid. |
... |
For extendibility. |
If no parameters, an empty list is returned.
A list of user-supplied parameters and parameter values for strata.
Tracey S. Frescino
xy_options(xvar="LON", yvar="LAT")xy_options(xvar="LON", yvar="LAT")