man-roxygen/SymbiotaR2.R

In pearselab/SymbiotaR2: Downloading Data from Symbiota2 Portals into R

#' @param url URL string of the Symbiota2 portal to be connected to. 
#' A trailing \code{/} will be appended, if it is not given. 
#' @param id id value (usually \code{numeric}, but not always) 
#' used to refer to the specific resource to pull from the database
#' @param page \code{numeric} value referring to the page of resources to pull.
#' If neither an id or a page parameter is provided, 
#' function will pull the first page of resources (i.e. \code{page=1})
#' 
#' @return If using \code{id}, the specific resource specified; 
#' if using page, the \code{page} specified of resources
#' 
#' @note To specify a default URL to refer to, see \code{\link[SymbiotaR2:SymbiotaR2_setup]{SymbiotaR2_setup()}}
#' 
#' @author Austin Koontz
#'