R/nbn_lists.R

In fozy81/NBN4R: National Biodiversity Network Atlas (UK and Ireland) Data and Resources in R

#' Species lists
#'
#' Note that this refers to pre-generated lists of species stored on the NBN servers. The similarly-named but different function \code{\link{specieslist}} provides a different function, namely listing the species matching a query or recorded as present in a search area.
#'
#' @references \url{https://lists.nbnatlas.org} and the associated web services at \url{https://lists.nbnatlas.org/ws}
#' @param druid string: data resource UID of the list (i.e. the list identifier)
#' @param kvp logical: include key-value pairs? Some lists contain information about the species in the form of key-value pairs
#' @param verbose logical: show additional progress information? 
#'
#' @return data.frame
#'
#' @seealso \code{\link{specieslist}} \code{\link{nbn_lists}}
#'
#' @examples
#' \dontrun{
#'  all_lists <- nbn_lists()
#'  ## find the "Field Guide apps species profiles" from Museum Victoria
#'  all_lists[grep("Field Guide",all_lists$listName),]
#'  ## download the vertebrates one
#'  l <- nbn_list(druid="dr1146")
#' }
#'
#' @export
nbn_list <- function(druid,kvp=TRUE,verbose=nbn_config()$verbose){
  
  ALA4R::ala_list(druid,kvp,verbose)
}


#' Find NBN species lists
#'
#' @references \url{https://lists.nbnatlas.org} and the associated web services at \url{https://lists.nbnatlas.org/ws}
#' @param guid string: (optional) if provided, return only lists in which this GUID appears
#' @param offset integer: the number of lists to skip. This supports paging
#' @param max integer: the maximum number of lists to return. This supports paging
#' @param verbose logical: show additional progress information? 
#'
#' @return data.frame of list name and other details
#'
#' @seealso \code{\link{nbn_list}}
#'
#' @examples
#' \dontrun{
#'  ## lists that include the giant African snail Achatina fulica
#'  ##  (which is a notifiable pest species in some states)
#'  l <- nbn_lists(search_guids("Achatina fulica")$guid)
#' }
#'
#' @export
nbn_lists <- function(guid,offset=0,max=500,verbose=nbn_config()$verbose) {
  
 ALA4R::ala_lists(guid,offset,max,verbose) 
  
}