R/datasets.R

In LambertW: Probabilistic Models to Analyze and Gaussianize Heavy-Tailed, Skewed Data

#' @title Datasets
#' @name datasets
#' @aliases AA SolarFlares
#' @description
#' Collection of datasets in this package.
#' @docType data
#' @importFrom utils data
#' @keywords datasets
#' 
NULL

#' @rdname datasets
#' @name AA
#' @description
#' 
#' The Australian athletes dataset (\code{AA}) were collected in a study of how
#'     data on various characteristics of the blood varied with sport body size
#'     and sex of the athlete.
#' @format
#' \code{AA} is a \code{data.frame} with 13 columns and 202 rows.
#' See \code{ais} dataset in the \pkg{DAAG} package for details.
#' 
#' @references Telford, R.D. and Cunningham, R.B. 1991.  Sex, sport and
#' body-size dependency of hematology in highly trained athletes.  Medicine and
#' Science in Sports and Exercise 23: 788-794.
#' @source 
#' \code{AA} was the basis for the analyses that are reported in 
#' Telford and Cunningham (1991).
#' @keywords datasets
#' 
NULL

#' @rdname datasets
#' @name SolarFlares
#' @description
#' The \code{SolarFlares} data are \eqn{12,773} observations of peak gamma-ray
#'     intensity of solar flares recorded from Feb, 1980 - Dec, 1989. It was
#'     analyzed for power-law properties in Clauset et al. (2009) and comes
#'     originally from Dennis et al.  (1991).  Thanks to the authors for giving
#'     permission to include the dataset in this package.
#' @references 
#' Dennis, B. R.; Orwig, L. E.; Kennard, G. S.; Labow, G. J.;
#' Schwartz, R. A.; Shaver, A. R.; Tolbert, A. K. (1991). ``The Complete Hard X
#' Ray Burst Spectrometer Event List, 1980-1989.'' NASA Technical Memorandum
#' 4332.
#' 
#' Clauset, A., C. R. Shalizi, and M. E. J. Newman (2009). ``Power-law
#' distributions in empirical data''. SIAM Review 51, 661-703 (2009). See also
#' \url{https://sites.santafe.edu/~aaronc/powerlaws/data.htm}.
#' 
#' @source 
#' Resources on the \code{SolarFlares} dataset can be found at:
#' 
#' \url{https://sites.santafe.edu/~aaronc/powerlaws/data.htm}
#' 
#' \url{https://ui.adsabs.harvard.edu/abs/1991chxb.book.....D/abstract}
#' 
#' See also References.
#' 
NULL