bbs_download: Download North American Breeding Bird Survey data via FTP

Description Usage Arguments Details Author(s) References Examples

Description

Download North American Breeding Bird Survey (BBS) data via FTP.

Usage

1
2
3
bbs_download(dest, bbs_dir = bbs_ftp(), countries = NULL,
  states = NULL, meta = TRUE, ten_stop = TRUE, fifty_stop = FALSE,
  overwrite = FALSE, verbose = TRUE)

Arguments

dest

Path to an existing local directory to download files to.

bbs_dir

Directory from which to get data. Defaults to the USGS FTP directory for the most recent BBS release. May alternatively be an FTP address for an older BBS release.

countries

Vector of countries to download 10- and/or 50-stop data for (e.g. c("Canada", "United States")). Defaults to all available. Case-insensitive. See Details.

states

Vector of states/provinces/territories to download 10- and/or 50-stop data for. Defaults to all available. Case-insensitive. See Details.

meta

Download top-level metadata files? Default is TRUE.

ten_stop

Download 10-stop data? Default is TRUE.

fifty_stop

Download 50-stop data? Default is FALSE.

overwrite

Overwrite files that already exist? Default is FALSE.

verbose

List files that were not re-downloaded because they already exist? Default is TRUE. Only applies if overwrite = FALSE.

Details

For names to use in arguments countries and states see bbs_meta_regions or BBS file RegionCodes.txt.

Note that country/state subsets are additive, so specifying

bbs_download(".", countries = "Canada", states = "Montana")

will download data for all Canadian provinces/territories plus the state of Montana. The following lines will both download data for all American states:

bbs_download(".", countries = "United States", states = "Florida")
bbs_download(".", countries = "United States")

Author(s)

Bob O'Hara

Patrick Barks <patrick.barks@gmail.com>

References

Pardieck, K.L., D.J. Ziolkowski Jr., M. Lutmerding and M.-A.R. Hudson. 2018. North American Breeding Bird Survey Dataset 1966-2017, version 2017.0. U.S. Geological Survey, Patuxent Wildlife Research Center. https://doi.org/10.5066/F76972V8

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
## Not run: 

# download metadata and 10-stop data for Alaska and all of Canada
bbs_download(dest = ".", countries = "Canada", states = "Alaska")

# download metadata and 10-stop data for Gulf Coast states
gulf_states <- c("Alabama", "Florida", "Louisiana", "Mississippi", "Texas")
bbs_download(dest = ".", states = gulf_states)

# download metadata and 50-stop data for all regions
bbs_download(dest = ".", ten_stop = FALSE, fifty_stop = TRUE)

## End(Not run)

patrickbarks/bbs documentation built on May 28, 2019, 12:34 a.m.