load_tiger_doc_template: Documentation Template for Functions that Utilize...
In tigris: Load Census TIGER/Line Shapefiles

load_tiger_doc_template

R Documentation

Documentation Template for Functions that Utilize `load_tiger`

Description

Documentation Template for Functions that Utilize load_tiger

Arguments

`...`	arguments to be passed to internal function `load_tiger`, which is not exported. See Additional Arguments.
`year`	the data year; defaults to 2021

Details

This documentation is inherited by tigris functions that wrap load_tiger. Include the following in function documentation: ⁠@inheritParams load_tiger_doc_template⁠ ⁠@inheritSection load_tiger_doc_template Additional Arguments⁠

Additional Arguments

Additional arguments that can be passed in ... are:

class Desired class of return object: "sf" (the default) or "sp". sp classes should be considered deprecated as of tigris version 2.0, but legacy support is still available.
progress_bar If set to FALSE, do not display download progress bar (helpful for R Markdown documents). Defaults to TRUE.
keep_zipped_shapefile If set to TRUE, do not delete zipped shapefile (stored in temporary directory or TIGRIS_CACHE_DIR depending on the configuration of global option "tigris_use_cache"). Defaults to FALSE.
refresh Whether to re-download cached shapefiles (TRUE or FALSE) . The default is either FALSE or the value of global option "tigris_refresh" if it is set. Specifying this argument will override the behavior set in "tigris_refresh" global option.
filter_by Geometry used to filter the output returned by the function. Can be an sf object, an object of class bbox, or a length-4 vector of format c(xmin, ymin, xmax, ymax) that can be converted to a bbox. Geometries that intersect the input to filter_by will be returned.