R/vertsummary.R

Defines functions vertsummary

Documented in vertsummary

#' Summarize a set of records downloaded from VertNet.
#'
#' Creates a simple summary of data returned by a VertNet search.
#'
#' @export
#' @param input Output from \code{\link{vertsearch}}, 
#'    \code{\link{searchbyterm}}, or \code{\link{spatialsearch}}. Required.
#' @param verbose Print progress and information messages. Default: TRUE
#' @return A list of summary statistics
#' @details \code{\link{vertsummary}} provides information on the sources, 
#' types and extent of data returned by a VertNet search.
#' @examples \dontrun{
#' # get occurrence records
#' recs <- vertsearch("Junco hyemalis", limit = 10)
#' 
#' # summarize occurrence records
#' vertsummary(recs)
#' 
#' vertsummary(vertsearch("Oncorhynchus clarki henshawi"))
#' }

vertsummary <- function(input, verbose = TRUE) vertsumwrapper(input, verbose)
ropensci/rvertnet documentation built on Feb. 18, 2024, 1:55 p.m.