is_peru_mammal: Check if species are Peru mammals

In perumammals: Taxonomic Backbone and Name Validation Tools for Mammals of Peru

Check if species are Peru mammals

Description

Main wrapper function that validates species names against the Peru mammals database with various output options for match quality, endemism status, and detailed information.

Usage

is_peru_mammal(
  splist,
  return_details = FALSE,
  match_type = "status",
  filter_exact = FALSE
)

Arguments

splist	Character vector of species names to check
return_details	Logical. If TRUE, returns full validation tibble. If FALSE, returns simplified status vector (default: FALSE)
match_type	Character. Type of information to return when return_details = FALSE: "status": Returns "Found" or "Not found" (default) "match_quality": Returns match quality ("Exact", "Fuzzy", or "Not found") "endemic": Returns endemism status ("Endemic", "Not endemic", or "Not found")
filter_exact	Logical. If TRUE, only returns exact matches (genus_dist = 0 AND species_dist = 0). Fuzzy matches are treated as "Not found" (default: FALSE)

Details

This function wraps validate_peru_mammals() to provide flexible output formats for different use cases:

• Basic presence/absence checking

• Match quality assessment (exact vs fuzzy)

• Endemism status queries

The function handles taxonomic matching with fuzzy string matching to accommodate minor spelling variations while maintaining data quality.

When filter_exact = TRUE, only matches with zero edit distance in both genus and species names are considered valid matches. All fields related to fuzzy matches are set to NA or "—" to maintain consistency.

Value

If return_details = FALSE: Character vector with requested information. If return_details = TRUE: Tibble with complete validation information.

Examples

species <- c(
  "Panthera onca",       # Exact match
  "Pantera onca",        # Fuzzy match (genus misspelled)
  "Tremarctos orrnatus", # Fuzzy match (species misspelled)
  "Felis domesticus",     # Not in Peru
  "Myotis bakeri"
)

# Check if species are found (includes fuzzy matches)
is_peru_mammal(species)

# Check with exact matches only
is_peru_mammal(species, filter_exact = TRUE)

# Check match quality
is_peru_mammal(species, match_type = "match_quality")

# Check endemism
is_peru_mammal(species, match_type = "endemic")

# Get detailed information
is_peru_mammal(species, return_details = TRUE)

# Get detailed information with exact matches only
is_peru_mammal(species, return_details = TRUE, filter_exact = TRUE)

perumammals documentation built on Jan. 6, 2026, 5:06 p.m.