R/data.R

#' Example dataset from ecology to illustrate fitting partially additive GAMs
#'
#' Original dataset was copied from 
#' https://stackoverflow.com/questions/37037445/using-mob-trees-partykit-package-with-nls-model 
#' For illustrating the funtionality of package gamtree, two noise variables 
#' were added: \code{noise} (a continuous variable) and `cluster_id` (a 
#' categorical indicator for a random intercept). 
#'
#' \itemize{
#'   \item Species: categorical partitioning variable, indicator for specie (signal).
#'   \item PAR: continuous predictor variable for the node-specific model (signal).
#'   \item Pn: continuous response variable.
#'   \item cluster_id: categorical covariate; indicator for a random intercept
#'   term (noise).
#'   \item noise: continuous covariate (noise).
#'   \item specimen:  number of individual plant.
#' }
#'
#' @name eco
#' @usage data(eco)
#' @docType data
#' @format A data frame with 628 observations and 5 variables
#' @keywords datasets
#' @examples data("eco")
#' summary(eco)
#' 
NULL
marjoleinF/gamtree documentation built on Sept. 17, 2021, 5:46 a.m.