Skip to content

Commit

Permalink
Update docs; shorten example
Browse files Browse the repository at this point in the history
  • Loading branch information
willgearty committed Dec 19, 2023
1 parent 027c68a commit 1185814
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
* added warning when specified size is more than 1000 times smaller than the y-axis range (mostly useful for when making maps with coord_sf) (#86)
* changed the defaults and behavior of the color and fill argument/aesthetics to better maintain backwards compatibility but also prevent unnecessary outlines (#87)
* added resolve_phylopic (#66)
* pick_phylopic now accepts a list of uuids via the uuid argument (#95)

# rphylopic 1.2.2

Expand Down
3 changes: 2 additions & 1 deletion R/pick_phylopic.R
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ utils::globalVariables(c("x", "y", "uuid", "label"))
#' of available images, all available uuids will be returned. Defaults to 5.
#' Only relevant if `name` supplied.
#' @param uuid \code{character}. A vector (or list) of valid PhyloPic
#' silhouette uuids, such as that returned by [get_uuid()].
#' silhouette uuids, such as that returned by [get_uuid()] or
#' [resolve_phylopic()].
#' @param view \code{numeric}. Number of silhouettes that should be plotted at
#' the same time. Defaults to 1.
#' @param filter \code{character}. Filter uuid(s) by usage license. Use "by"
Expand Down
2 changes: 1 addition & 1 deletion R/resolve_phylopic.R
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
#' # get a uuid for a single name
#' resolve_phylopic(name = "Canis lupus")
#' # get uuids for the taxonomic hierarchy
#' resolve_phylopic(name = "Canis lupus", hierarchy = TRUE)
#' resolve_phylopic(name = "Canis lupus", hierarchy = TRUE, max_ranks = 3)
resolve_phylopic <- function(name, api = "gbif.org", hierarchy = FALSE,
max_ranks = 5, n = 1, filter = NULL, url = FALSE) {
url_arg <- url
Expand Down
3 changes: 2 additions & 1 deletion man/pick_phylopic.Rd

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

2 changes: 1 addition & 1 deletion man/resolve_phylopic.Rd

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

0 comments on commit 1185814

Please sign in to comment.