R/data.R

# fire_konza_ratajczak --------------------------------------------------------------
#' Konza LTER Fires - Ratajczak et al.
#'
#' Konza LTER Fire Dataset
#'
#' @docType data
#' @format A list of two elements: c('dataset','attributes'). Dataset contains the original data. Attributes describe the use of each variable in the paper referenced.
#' @keywords dataset, regime shift, lter, fire, controlled burn
#' @references
#' (\href{url or doi here}{publisher})
#'
#' @source \href{url or doi here}{citation or poublisher whatever}
#' @examples
#' data("fire_konza_ratajczak")

"fire_konza_ratajczak"

# diatoms_galapagos --------------------------------------------------------------
#' Diatoms - Seddon et al. (YYYY)
#'
#' Data from publication....more description here.
#'
#' @docType data
#' @usage data(diatoms_galapagos)
#' @format An object of class S3 (tibble) with dimensions 6,696 × 4.
#' @keywords dataset, regime shift, diatom
#' @references
#' (\href{url or doi here}{publisher})
#'
#' @source \href{url or doi here}{citation or poublisher whatever}
#' @examples
#' data(diatoms_galapagos)

"diatoms_galapagos"

# groundfish --------------------------------------------------------------
#' Groundfish data title will go here
#'
#' Data from publication....more description here.
#'
#' @docType data
#' @usage data(groundfish)
#' @format An object of class S3 (tibble) with dimensions 105,879 × 9.
#' @keywords dataset, regime shift, fish, community, abrupt change
#' @references Pedersen et al. something or other
#' (\href{url or doi here}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data(groundfish)

"groundfish"

# everglades --------------------------------------------------------------
#' Everglades data title will go here
#'
#' Data from publication....more description here.
#'
#' @docType data
#' @format An object of class S3 (tibble) with dimensions 20,664 × 4.
#' @keywords dataset, everglades, community, abrupt change
#' @references reference goes here
#' (\href{url or doi here}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data(everglades)

"everglades"

# gradual_noncrit --------------------------------------------------------------
#' Simulated Data Exhibiting Gradual Non-Critical Shift
#'
#' Code adapted from Stegner et al (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63 DOI: 10.1016/j.quascirev.2019.01.009

#'
#' @docType data
#' @keywords simulation, woody cover
#' @references  Stegner, Ratajczak, Carpenter, & Williams (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63
#' (\href{10.1016/j.quascirev.2019.01.009}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data("gradual_noncrit")

"gradual_noncrit"

# gradual_crit--------------------------------------------------------------
#' Simulated Data for Gradual Critical Transition
#'
#' Code adapted from Stegner et al (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63 DOI: 10.1016/j.quascirev.2019.01.009
#' @docType data
#' @keywords simulation, woody cover
#' @references  Stegner, Ratajczak, Carpenter, & Williams (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63

#' (\href{10.1016/j.quascirev.2019.01.009}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data(gradual_crit)

"gradual_crit"


# abrupt_crit--------------------------------------------------------------
#' Simulated Data for Data Exhibiting Abrupt Critical Transition
#'
#' Code adapted from Stegner et al (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63 DOI: 10.1016/j.quascirev.2019.01.009
#'
#' @docType data
#' @keywords simulation, woody cover
#' @references  Stegner, Ratajczak, Carpenter, & Williams (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63

#' (\href{10.1016/j.quascirev.2019.01.009}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data(abrupt_crit)

"abrupt_crit"

# no_change--------------------------------------------------------------
#' Simulated Data for Data Exhibiting No Transition
#'
#' Code adapted from Stegner et al (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63 DOI: 10.1016/j.quascirev.2019.01.009
#' @docType data
#' @keywords  simulation, woody cover
#' @references  Stegner, Ratajczak, Carpenter, & Williams (2019) Inferring critical transitions in paleoecological time series with irregular sampling and variable time-averaging. Quaternary Science Reviews 207: 49-63

#' (\href{10.1016/j.quascirev.2019.01.009}{publisher})
#'
#' @source \href{url or doi here}{citation or publisher here}
#'
#' @examples
#' data(no_change)

"no_change"
regime-shifts/abruptdata documentation built on Aug. 13, 2021, 12:10 a.m.