Learn R Programming

tigris (version 2.2.1)

linear_water: Download an linear water shapefile into R

Description

From the US Census Bureau: "The linear hydrography shapefile contains all linear features with "H" (Hydrography) type MTFCCs in the MAF/TIGER database by county. The shapefiles are provided at a county geographic extent and in linear elemental feature geometry. The linear hydrography shapefile includes streams/rivers, braided streams, canals, ditches, artificial paths, and aqueducts. A linear hydrography feature may include edges with both perennial and intermittent persistence."

Usage

linear_water(state, county, year = NULL, ...)

Arguments

state

The two-digit FIPS code of the state of the county you'd like to download the water features for. Can also be state name or abbreviation (case-insensitive).

county

The three-digit FIPS code of the county you'd like the water features for. Can also be a county name.

year

the data year; defaults to 2024

...

arguments to be passed to internal function load_tiger, which is not exported. See 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.

  • protocol Character string specifying the protocol to use for downloading files. Options are "ftp" or "http" (default). If "ftp", the URL will be modified to use FTP instead of HTTPS.

  • timeout Integer specifying the timeout in seconds for download operations if protocol is "ftp". Defaults to 1800 (30 minutes) to handle large files.

See Also

Examples

Run this code
if (FALSE) {
library(tigris)

dallas_water <- linear_water("TX", "Dallas")

plot(dallas_water$geometry)

}

Run the code above in your browser using DataLab