R/data.R

#' An distribution data set
#' 
#' A dataset containing the distributions from three samples
#' 
#' @format A data frame with 100 rows and 4 variables:
#' \describe{
#' \item{size}{Size of granule, in um}
#' \item{118 - Average}{Distribution of sample}
#' \item{206 - Average}{Distribution of sample}
#' \item{85 - Average}{Distribution of sample}
#' }
#' 
"Dist"

#' An example mix_dist output
#' 
#' A dataset containing the output from 118 - Average
#' 
#' @format A data frame with 3 rows and 8 variables:
#' \describe{
#' \item{sample}{Name of the sample}
#' \item{peak}{Peak name}
#' \item{pi}{Distribution proportion}
#' \item{mu}{Distribution mean}
#' \item{sigma}{Distribution sd}
#' \item{pi.se}{proportion standard error}
#' \item{mu.se}{mean standard error}
#' \item{sigma.se}{sd standard error}
#' }
#' 
"ms1"

#' An example mix_dist output
#' 
#' A dataset containing the output from 85 - Average
#' 
#' @format A data frame with 3 rows and 8 variables:
#' \describe{
#' \item{sample}{Name of the sample}
#' \item{peak}{Peak name}
#' \item{pi}{Distribution proportion}
#' \item{mu}{Distribution mean}
#' \item{sigma}{Distribution sd}
#' \item{pi.se}{proportion standard error}
#' \item{mu.se}{mean standard error}
#' \item{sigma.se}{sd standard error}
#' }
#' 
"ms2"

#' An example mix_dist output
#' 
#' A dataset containing the output from 206 - Average
#' 
#' @format A data frame with 3 rows and 8 variables:
#' \describe{
#' \item{sample}{Name of the sample}
#' \item{peak}{Peak name}
#' \item{pi}{Distribution proportion}
#' \item{mu}{Distribution mean}
#' \item{sigma}{Distribution sd}
#' \item{pi.se}{proportion standard error}
#' \item{mu.se}{mean standard error}
#' \item{sigma.se}{sd standard error}
#' }
#' 
"ms3"
csiro-crop-informatics/granular documentation built on June 5, 2020, 1:45 p.m.