find_refuges: Find refuges or properties available for query.

Description Usage Arguments Value Examples

View source: R/find_refuges.R

Description

Find refuges or properties available for query.

Usage

1
2
find_refuges(refuge = NULL, ptype = c("NWR", "NFH", "WMD", "WMA", "WPA"),
  region = 1:8L)

Arguments

refuge

character string scalar or vector (i.e., multiple entries allowed and regular expressions allowed) with which to search and return valid refuge or hatchery identifiers for use with inat_retrieve. Default ('NULL') returns all available National Wildlife Refuges (see ptype argument. Case-insensitive search. Regular expressions allowed. See Examples.

ptype

character string scalar or vector of types of USFWS properties to search. Default is to search all property types. Other viable options include National Wildlife Refuges only ptype = "NWR", "NFH" (National Fish Hatchery; southeast region only at the moment), "WMD" (Wetland Managment District), "WMA" (Wildlife Management Area), and WPA" (Waterfowl Production Area). Any combination of options is permissible.

region

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

Value

character scalar or vector of proper organizational name (ORGNAME) for USFWS properties meeting the search criteria. This output can be passed directly as the refuge argument in inat_retrieve.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
## Not run: 
# Get all available properties
all_props <- find_refuges()

# Get all National Wildlife Refuges
all_refs <- find_refuges(ptype = "NWR")

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

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

# Same search using regular expressions
multi <- find_refuges("longleaf|romain")

# Return all southeast (region 4) refuges
r4 <- find_refuges(region = 4, ptype = "NWR")

## End(Not run)

adamdsmith/fwsinat documentation built on May 29, 2019, 2:10 p.m.