R/qc_taxa_match_official.R
qc_taxa_match_official.RdThis function compares the user's data frame to a data frame with the official (or user supplied) master taxa list. The function is agnostic to the type of data, i.e., it is only looking at the names.
qc_taxa_match_official(
DF_User,
DF_Official = NULL,
fun.Community = NULL,
useOfficialTaxaInfo = "only_Official",
col_taxon = "TAXAID"
)User taxa data.
Official master taxa list. Can be a local file or from a URL. Default is NULL. A NULL value will use the official online files.
Community name for which to compare the master taxa list (bugs or fish).
Select how to handle new/different taxa. See 'Details' for more information. Valid values are "only_Official", "only_user", "add_new". Default = "only_Official".
Column with taxa names. Default = TAXAID
input data frame with master taxa information added to it.
Some official lists are stored online but the user can input their own project specific file.
Output is a data frame with matches.
Messages are output to the console with the number of matches and which user taxa did not match the official list.
Any columns in the user input file that match the official master taxa list will be renamed with the "_NonOfficial" suffix.
New/different taxa in the user data are handled by the 'useOfficialTaxaInfo' parameter. For taxa that did not match the master taxa list the user has options on how to handle the differences for the phylogeny (e.g., columns for phylum, class, family, etc.) and autecology (e.g., columns for FFG, habit, tolerance value, etc.). The options are below.
* only_official = use only official master taxa information. Any non-matching taxa will not have any master taxa information.
* only_user = only use the information provided by the user. Information from the 'Official' will not be used. This should only be used for non-official calculations.
* add_new = hybrid approach that uses official master taxa information, when present, but includes user information for non-matching taxa if the column names match.
Default master taxa lists are saved as CSV files online at:
https://github.com/leppott/MBSStools_SupportFiles
The files can be downloaded with the following code.
**Benthic Macroinvertebrate**
url_mt_bugs <- "https://github.com/leppott/MBSStools_SupportFiles/raw/master/Data/CHAR_Bugs.csv" df_mt_bugs <- read.csv(url_mt_bugs)
The master taxa files are periodically updated. Update dates will be logged on the GitHub repository.
Expected fields include:
**Benthic Macroinvertebrates**
+ TAXON, Phylum, Class, Order, Family, Tribe, Genus, Other_Taxa, FFG, FAM_TV, Habit, FinalTolVal07, Comment
This function was called qc_taxa prior to March 2026 update. The older function has been deprecated and may be removed in a future release.
This function is still under development to make it more generic.
# Example 1, Master Taxa List, Bugs
url_mt_bugs <- "https://github.com/leppott/MBSStools_SupportFiles/raw/master/Data/CHAR_Bugs.csv"
df_mt_bugs <- read.csv(url_mt_bugs)
# User data
DF_User <- data_benthos_MBSS
DF_Official <- NULL # NULL df_mt_bugs
fun.Community <- "bugs"
useOfficialTaxaInfo <- "only_Official"
col_taxon <- "TAXON"
# modify taxa id column
DF_User[, "TAXON"] <- DF_User[, "TAXAID"]
df_qc_taxa_bugs <- qc_taxa_match_official(DF_User,
DF_Official,
fun.Community,
useOfficialTaxaInfo,
col_taxon)
#> Taxa match, 313 / 313
# Example 2, Algae, non-ASCII included
df_qc_taxa_algae <- qc_taxa_match_official(
DF_User = data_algae_names_user,
DF_Official = data_algae_names_official,
fun.Community = "algae",
useOfficialTaxaInfo = "only_Official",
col_taxon = "Taxon"
)
#> Taxa match, 3269 / 3269