better description of imprecise_fuzzy_matches (#221)

* better description of `imprecise_fuzzy_matches`

closes issue #155

R/align_taxa.R

@@ -13,12 +13,18 @@
 #' @param output (optional) The name of the file to save the results to.
 #' @param full Parameter to determine how many columns are output
 #' @param resources the taxonomic resources used to align the taxa names. Loading this can be slow,
-#' so call \code{\link{load_taxonomic_resources}} separately to greatly speed this function up and pass the resources in.
+#' so call \code{\link{load_taxonomic_resources}} separately to greatly speed this function up 
+#' and pass the resources in.
 #' @param quiet Logical to indicate whether to display messages while aligning taxa.
 #' @param fuzzy_abs_dist The number of characters allowed to be different for a fuzzy match.
 #' @param fuzzy_rel_dist The proportion of characters allowed to be different for a fuzzy match. 
-#' @param fuzzy_matches Fuzzy matches are turned on as a default. The relative and absolute distances allowed for fuzzy matches to species and infraspecific taxon names are defined by the parameters `fuzzy_abs_dist` and `fuzzy_rel_dist`
-#' @param imprecise_fuzzy_matches Imprecise fuzzy matches are turned off as a default.
+#' @param fuzzy_matches Fuzzy matches are turned on as a default. The relative and absolute distances 
+#' allowed for fuzzy matches to species and infraspecific taxon names are defined by the parameters 
+#' `fuzzy_abs_dist` and `fuzzy_rel_dist`
+#' @param imprecise_fuzzy_matches Imprecise fuzzy matches uses the fuzzy matching function
+#' with lenient levels set (absolute distance of 5 characters; relative distance = 0.25). 
+#' It offers a way to get a wider range of possible names, possibly corresponding to very distant spelling mistakes. 
+#' This is FALSE as default and all outputs should be checked as it often makes erroneous matches.
 #' @param APNI_matches Name matches to the APNI (Australian Plant Names Index) are turned on as a default.
 #' @param identifier A dataset, location or other identifier, which defaults to NA.
 #'

R/create_taxonomic_update_lookup.R

@@ -16,7 +16,10 @@
 #' @param fuzzy_matches Fuzzy matches are turned on as a default. The relative and absolute distances allowed for fuzzy matches to species and infraspecific taxon names are defined by the parameters `fuzzy_abs_dist` and `fuzzy_rel_dist`
 #' @param resources These are the taxonomic resources used for cleaning, this will default to loading them from a local place on your computer.  If this is to be called repeatedly, it's much faster to load the resources using \code{\link{load_taxonomic_resources}} separately and pass the data in.
 #' @param APNI_matches Name matches to the APNI (Australian Plant Names Index) are turned off as a default. 
-#' @param imprecise_fuzzy_matches Imprecise fuzzy matches are turned on as a default.
+#' @param imprecise_fuzzy_matches Imprecise fuzzy matches uses the fuzzy matching function
+#' with lenient levels set (absolute distance of 5 characters; relative distance = 0.25). 
+#' It offers a way to get a wider range of possible names, possibly corresponding to very distant spelling mistakes. 
+#' This is FALSE as default and all outputs should be checked as it often makes erroneous matches.
 #' @param identifier A dataset, location or other identifier, which defaults to NA.
 #' @param quiet Logical to indicate whether to display messages while aligning taxa.
 #' @param output file path to save the output. If this file already exists, this function will check if it's a subset of the species passed in and try to add to this file. This can be useful for large and growing projects. 

R/match_taxa.R

@@ -11,8 +11,13 @@
 #' @param resources The list(s) of accepted names to check against, loaded through the function `load_taxonomic_resources()`
 #' @param fuzzy_abs_dist The number of characters allowed to be different for a fuzzy match.
 #' @param fuzzy_rel_dist The proportion of characters allowed to be different for a fuzzy match. 
-#' @param fuzzy_matches Fuzzy matches are turned on as a default. The relative and absolute distances allowed for fuzzy matches to species and infraspecific taxon names are defined by the parameters `fuzzy_abs_dist` and `fuzzy_rel_dist`
-#' @param imprecise_fuzzy_matches Imprecise fuzzy matches are turned off as a default.
+#' @param fuzzy_matches Fuzzy matches are turned on as a default. The relative and absolute distances 
+#' allowed for fuzzy matches to species and infraspecific taxon names are defined by the parameters 
+#' `fuzzy_abs_dist` and `fuzzy_rel_dist`
+#' @param imprecise_fuzzy_matches Imprecise fuzzy matches uses the fuzzy matching function
+#' with lenient levels set (absolute distance of 5 characters; relative distance = 0.25). 
+#' It offers a way to get a wider range of possible names, possibly corresponding to very distant spelling mistakes. 
+#' This is FALSE as default and all outputs should be checked as it often makes erroneous matches.
 #' @param APNI_matches Name matches to the APNI (Australian Plant Names Index) are turned off as a default.
 #' @param identifier A dataset, location or other identifier, which defaults to NA.
 #'