R/trichoptera.R

#' Trichoptera data set
#'
#' Data gathered between 1959 and 1960 during 49 insect trapping nights.
#' For each trapping night, the abundance of 17 Trichoptera
#' species is recorded as well as 6 meteorological variables which may influence
#' the abundance of each species. Finally, the observations (that is to say,
#' the trapping nights), have been classified into 12 groups corresponding to
#' contiguous nights between summer 1959 and summer 1960.
#'
#' @format A list with 2 two data frames:
#' \describe{
#'   \item{Abundance}{a 49 x 17 matrix of abundancies/counts (49 trapping nights and 17 trichoptera species)}
#'   \item{Covariate}{a 49 x 7 data frame of covariates:
#'   \describe{
#'   \item{Temperature}{Evening Temperature in Celsius}
#'   \item{Wind}{Wind in m/s}
#'   \item{Pressure}{Pressure in mm Hg}
#'   \item{Humidity}{relative to evening humidity in percent}
#'   \item{Cloudiness}{proportion of sky coverage at 9pm}
#'   \item{Precipitation}{Nighttime precipitation in mm}
#'   \item{Group}{a factor of 12 levels for the definition of the consecutive night groups}
#'   }
#'   }
#' }
#'
#' In order to prepare the data for using formula in multivariate analysis (multiple outputs and inputs), use [prepare_data()].
#' We only kept a subset of the original meteorological covariates for illustration purposes.
#'
#' @seealso [prepare_data()]
#' @references Usseglio-Polatera, P. and Auda, Y. (1987) Influence des facteurs météorologiques sur les résultats de piégeage lumineux. Annales de Limnologie, 23, 65–79. (code des espèces p. 76)
#' See a data description at \href{http://pbil.univ-lyon1.fr/R/pdf/pps034.pdf}{http://pbil.univ-lyon1.fr/R/pdf/pps034.pdf} (in French)
#' @examples
#' data(trichoptera)
#' trichoptera <- prepare_data(trichoptera$Abundance, trichoptera$Covariate)
#' @source Data from P. Usseglio-Polatera.
"trichoptera"
PLN-team/PLNmodels documentation built on April 15, 2024, 9:01 a.m.