Skip to content

Commit

Permalink
Cran prep (#67)
Browse files Browse the repository at this point in the history
* fixing notes from devtools::check() with fonti's knowledge and tricks
  • Loading branch information
wcornwell authored Jul 27, 2023
1 parent bb17d17 commit ba81220
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 8 deletions.
58 changes: 50 additions & 8 deletions R/ausflora-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,74 @@
#'
#' @description
#' The process of standardising taxon names is necessary when working with
#' biodiversity data. 'ausflora' uses the Australian Plant Name Index (APNI)
#' and the Australian Plant Census (APC) to align and update plant taxon names
#' biodiversity data. 'ausflora' uses the Australian Plant Name Index (APNI)
#' and the Australian Plant Census (APC) to align and update plant taxon names
#' to current, accepted standards. 'ausflora' can also supply information about
#' the established status of plant taxa across different states/territories.
#'
#'
#' @name ausflora
#' @docType package
#' @references If you have any questions, comments or suggestions, please
#' @references If you have any questions, comments or suggestions, please
#' submit an issue at our [GitHub repository](https://github.com/traitecoevo/ausflora/issues)
#' @keywords internal
#' @section Functions:
#' **Standarise taxon names**
#'
#'
#' * [load_taxonomic_resources]
#' * [create_taxonomic_update_lookup]
#' * [align_taxa]
#' * [update_taxonomy]
#'
#'
#' **Established status by region**
#'
#'
#' * [state_diversity_counts]
#' * [create_species_state_origin_matrix]
#' * [native_anywhere_in_australia]
#'
#'
"_PACKAGE"

## usethis namespace: start
## usethis namespace: end
NULL
utils::globalVariables(
c(
".",
"acceptedNameUsage",
"acceptedNameUsageID",
"aligned_name",
"aligned_reason",
"alternativeTaxonomicStatusClean",
"binomial",
"canonicalName",
"canonical_name",
"ccAttributionIRI",
"checked",
"cleaned_name",
"family",
"fuzzy_match_genus",
"fuzzy_match_genus_APNI",
"fuzzy_match_genus_known",
"genus",
"my_order",
"nameElement",
"nameType",
"native_anywhere",
"original_name",
"scientificName",
"scientificNameAuthorship",
"scientificNameID",
"stripped_canonical",
"stripped_canonical2",
"stripped_name",
"stripped_name2",
"subclass",
"taxonDistribution",
"taxonID",
"taxonIDClean",
"taxonRank",
"taxonomicStatus",
"taxonomicStatusClean",
"taxonomic_ref",
"trinomial"
)
)
2 changes: 2 additions & 0 deletions R/clean_names.R
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,9 @@ redistribute <- function(data) {
#' update_taxonomy(c("Eucalyptus pauciflora", "Acacia victoriae"))
#'
#' # Update taxonomy for two plant names and save the result to a CSV file
#' \dontrun{
#' update_taxonomy(c("Eucalyptus pauciflora", "Acacia victoriae"), output = "updated_taxonomy.csv")
#' }
update_taxonomy <- function(aligned_names,
output = NULL,
resources = load_taxonomic_resources()) {
Expand Down
2 changes: 2 additions & 0 deletions man/update_taxonomy.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ba81220

Please sign in to comment.