R/documentationDatasets.r

#' Mokihinui example dataset for Veg-X
#'
#' Forest and riparian data from 5 plots (with four sub-plots each) from the west coast of South Island (New Zealand).  
#' The data comprises i) site information from each plot; ii) cover scores of taxa within height strata; and iii) dbh measurement of individual trees.
#' The data set includes four data frames:
#'
#' \itemize{
#'  \item moki_loc Location of vegetation plots (5 records x 25 variables)
#'  \item moki_site Site characteristics of plots/subplots (25 records x 41 variables)
#'  \item moki_tcv Observations of cover of taxon categories, grouped by vegetation strata (582 records x 30 variables)
#'  \item moki_dia Observations made on individual trees (643 records x 30 variables)
#'  \item moki_str Observations of the cover of surface types (35 records x 20 variables)
#'  \item moki_lookup Lookup table to translate species names
#' }
#'
#' @name mokihinui
#' @aliases moki_loc moki_site moki_tcv moki_dia moki_lookup moki_str
#' @docType data
#' @author New Zealand National Vegetation Survey (NVS) Databank (https://nvs.landcareresearch.co.nz/).
#' @keywords data
#' @references Wiser, S.K., P.J. Bellingham and L.E. Burrows.  2001.  Managing biodiversity information:  development of the National Vegetation Survey Databank.  New Zealand Journal of Ecology 25(2): 1-17.
NULL

#' Mt Fyffe example dataset for Veg-X
#'
#' Forest data from five permanent plots from the east coast of South Island (New Zealand).  
#' The data comprises i) site information from each plot; ii) cover scores of taxa within height strata; 
#' iii) dbh measurement of individual trees within subplots that fully partition the permanent plot; 
#' iv) counts of saplings within subplots that fully partition the permanent plot; 
#' and v) counts of seedlings within height strata within subplots that sample the permanent plot.  
#' Two full measurements of the permanent plots are provided. The data set includes six data frames:
#'
#' \itemize{
#'  \item mtfyffe_loc Location of vegetation plots (10 records x 25 variables)
#'  \item mtfyffe_site Site characteristics of plots/subplots (325 records x 29 variables)
#'  \item mtfyffe_counts Observations of counts of taxon categories, grouped by vegetation strata (543 records x 30 variables)
#'  \item mtfyffe_dia Observations made on individual trees (880 records x 31 variables)
#'  \item mtfyffe_disturbance Observations of disturbance events on plots (9 records x 10 variables)
#'  \item mtfyffe_groundcover Observations of ground cover on plots (50 records x 12 variables)
#'  \item mtfyffe_lookup Lookup table to translate species names
#'
#' }
#'
#' @name mtfyffe
#' @aliases mtfyffe_loc mtfyffe_site mtfyffe_counts mtfyffe_dia mtfyffe_disturbance mtfyffe_groundcover mtfyffe_lookup
#' @docType data
#' @author New Zealand National Vegetation Survey (NVS) Databank (https://nvs.landcareresearch.co.nz/).
#' @keywords data
#' @references Wiser, S.K., P.J. Bellingham and L.E. Burrows.  2001.  Managing biodiversity information:  development of the National Vegetation Survey Databank.  New Zealand Journal of Ecology 25(2): 1-17.
NULL



#' Takitimu example dataset for Veg-X
#'
#' Alpine grassland data from 5 plots from the southern South Island (New Zealand). 
#' The data comprises i) site information from each plot; ii) frequency values for plant taxa based on observations within subplots along transects; 
#' iii) groundcover; iv) disturbance. The data set includes five data frames:
#'
#' \itemize{
#'  \item taki_loc Location of vegetation plots (10 records x 25 variables)
#'  \item taki_site Site characteristics of plots/subplots (325 records x 29 variables)
#'  \item taki_freq Observations of frequency of taxon categories (543 records x 30 variables)
#'  \item taki_disturbance Observations of disturbance events on plots (9 records x 10 variables)
#'  \item taki_groundcover Observations of ground cover on plots (50 records x 12 variables)
#'  \item taki_lookup Lookup table to translate species names
#' }
#'
#' @name takitimu
#' @aliases taki_loc taki_site taki_freq taki_disturbance taki_groundcover taki_lookup
#' @docType data
#' @author New Zealand National Vegetation Survey (NVS) Databank (https://nvs.landcareresearch.co.nz/).
#' @keywords data
#' @references Wiser, S.K., P.J. Bellingham and L.E. Burrows.  2001.  Managing biodiversity information:  development of the National Vegetation Survey Databank.  New Zealand Journal of Ecology 25(2): 1-17.
NULL
miquelcaceres/VegX documentation built on Sept. 18, 2022, 7:04 p.m.