find_fws: Find USFWS properties available for query

View source: R/find_fws.R

find_fwsR Documentation

Find USFWS properties available for query

Description

Find USFWS properties available for query

Usage

find_fws(fws = NULL, ptype = "NWR", region = 1:8L)

Arguments

fws

character string scalar or vector (i.e., multiple entries allowed) with which to search and return valid USFWS identifiers (i.e., ORGNAMEs) for species occurrence queries. Default ('NULL') returns all available National Wildlife Refuges, but other property types are available (see ptype argument). The search is case-insensitive and matches partial strings. Regular expressions are also allowed. See examples.

ptype

character string scalar or vector of types of USFWS properties to search. Default is to search for National Wildlife Refuges only (ptype = "NWR"). Other options include "WPA" (Waterfowl Production Areas), "WMA" (Wildlife Management Areas), "FSA" (Farm Service Agency properties), and "NFH" (National Fish Hatcheries).

region

integer indicating which USFWS Region(s) to search ( https://www.fws.gov/where); valid values range from 1 to 8

Value

data.frame of organizational names (ORGNAME) of USFWS properties meeting the search criteria and their associate USFWS region. This output can be passed directly to fws_occ as the fws argument.

Examples

## Not run: 
# Get all National Wildlife Refuges
all_refs <- find_fws()

# Search for refuges using a partial name match
ml <- find_fws("longleaf")

# Search for refuges matching multiple strings
multi <- find_fws(c("longleaf", "romain"))

# Regular expressions also work
multi <- find_fws("longl|romain")

# Search for all refuges beginning with "T"
ts <- find_fws("^t")

# Return all southeast (region 4) refuges
r4 <- find_fws(region = 4)

# Return all mountain-prairie (region 6) refuges and waterfowl production areas
r6 <- find_fws(ptype = c("NWR", "WPA"), region = 6)

# All refuges
# Issues a warning due to duplicate organizational names
nwr <- find_fws()

## End(Not run)

adamdsmith/fwspp documentation built on May 14, 2024, 10:28 a.m.