added to man files about being albe to regex filter #385

R/get_boldid.R

@@ -37,7 +37,8 @@
 #' @section Filtering:
 #' The parameters \code{division}, \code{parent}, and \code{rank} are not
 #' used in the search to the data provider, but are used in filtering the data down to a
-#' subset that is closer to the target you want.
+#' subset that is closer to the target you want.  For all these parameters,
+#' you can use regex strings since we use \code{\link{grep}} internally to match.
 #'
 #' @seealso \code{\link[taxize]{get_uid}}, \code{\link[taxize]{classification}}
 #'

R/get_colid.R

@@ -32,7 +32,8 @@
 #' @section Filtering:
 #' The parameters \code{kingdom}, \code{phylum}, \code{class}, \code{order}, \code{family},
 #' and \code{rank} are not used in the search to the data provider, but are used in filtering
-#' the data down to a subset that is closer to the target you want.
+#' the data down to a subset that is closer to the target you want. For all these parameters,
+#' you can use regex strings since we use \code{\link{grep}} internally to match.
 #'
 #' @seealso \code{\link[taxize]{get_tsn}}, \code{\link[taxize]{get_colid}},
 #' \code{\link[taxize]{get_tpsid}}, \code{\link[taxize]{get_eolid}}

R/get_gbifid.R

@@ -40,7 +40,8 @@
 #' @section Filtering:
 #' The parameters \code{phylum}, \code{class}, \code{order}, \code{family}, and \code{rank}
 #' are not used in the search to the data provider, but are used in filtering the data down
-#' to a subset that is closer to the target you want.
+#' to a subset that is closer to the target you want.  For all these parameters,
+#' you can use regex strings since we use \code{\link{grep}} internally to match.
 #'
 #' @examples \dontrun{
 #' get_gbifid(sciname='Poa annua')

R/get_tpsid.R

@@ -27,7 +27,8 @@
 #' @section Filtering:
 #' The parameters \code{family} and \code{rank} are not used in the search to the data
 #' provider, but are used in filtering the data down to a subset that is closer to the
-#' target you want.
+#' target you want.  For all these parameters,
+#' you can use regex strings since we use \code{\link{grep}} internally to match.
 #'
 #' @seealso \code{\link[taxize]{get_tsn}}, \code{\link[taxize]{get_tpsid}}
 #'

R/get_ubioid.R

@@ -32,7 +32,8 @@
 #' @section Filtering:
 #' The parameters \code{family} and \code{rank} are not used in the search to the data
 #' provider, but are used in filtering the data down to a subset that is closer to the
-#' target you want.
+#' target you want.  For all these parameters,
+#' you can use regex strings since we use \code{\link{grep}} internally to match.
 #'
 #' @seealso \code{\link[taxize]{get_uid}}, \code{\link[taxize]{ubio_search}}
 #'

R/get_uid.R

@@ -33,7 +33,8 @@
 #' @section Filtering:
 #' The parameters \code{division} and \code{rank} are not used in the search to the
 #' data provider, but are used in filtering the data down to a subset that is closer
-#' to the target you want.
+#' to the target you want.  For all these parameters, you can use regex strings since
+#' we use \code{\link{grep}} internally to match.
 #'
 #' @seealso \code{\link[taxize]{get_tsn}}, \code{\link[taxize]{classification}}
 #'

man/get_boldid.Rd

@@ -85,7 +85,8 @@ Get the BOLD (Barcode of Life) code for a search term.
 
 The parameters \code{division}, \code{parent}, and \code{rank} are not
 used in the search to the data provider, but are used in filtering the data down to a
-subset that is closer to the target you want.
+subset that is closer to the target you want.  For all these parameters,
+you can use regex strings since we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{

man/get_colid.Rd

@@ -81,7 +81,8 @@ Get the Catalogue of Life ID from taxonomic names.
 
 The parameters \code{kingdom}, \code{phylum}, \code{class}, \code{order}, \code{family},
 and \code{rank} are not used in the search to the data provider, but are used in filtering
-the data down to a subset that is closer to the target you want.
+the data down to a subset that is closer to the target you want. For all these parameters,
+you can use regex strings since we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{

man/get_gbifid.Rd

@@ -82,7 +82,8 @@ exact match we return the options to you to pick from.
 
 The parameters \code{phylum}, \code{class}, \code{order}, \code{family}, and \code{rank}
 are not used in the search to the data provider, but are used in filtering the data down
-to a subset that is closer to the target you want.
+to a subset that is closer to the target you want.  For all these parameters,
+you can use regex strings since we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{

man/get_tpsid.Rd

@@ -71,7 +71,8 @@ Get the NameID codes from Tropicos for taxonomic names.
 
 The parameters \code{family} and \code{rank} are not used in the search to the data
 provider, but are used in filtering the data down to a subset that is closer to the
-target you want.
+target you want.  For all these parameters,
+you can use regex strings since we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{

man/get_ubioid.Rd

@@ -75,7 +75,8 @@ to search for names.
 
 The parameters \code{family} and \code{rank} are not used in the search to the data
 provider, but are used in filtering the data down to a subset that is closer to the
-target you want.
+target you want.  For all these parameters,
+you can use regex strings since we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{

man/get_uid.Rd

@@ -75,7 +75,8 @@ Retrieve the Unique Identifier (UID) of a taxon from NCBI taxonomy browser.
 
 The parameters \code{division} and \code{rank} are not used in the search to the
 data provider, but are used in filtering the data down to a subset that is closer
-to the target you want.
+to the target you want.  For all these parameters, you can use regex strings since
+we use \code{\link{grep}} internally to match.
 }
 \examples{
 \dontrun{