R/PF-package.r

#' @name New
#' @title New dataset
#' @description New dataset
#' @docType data
#' @format a data frame with 52 observations of the following 3 variables, no
#'   NAs \describe{
#'
#'   \item{cage}{cage ID. 1 - 26}
#'
#'   \item{tx}{treatment. one of 'con' or 'vac'}
#'
#'   \item{pos}{numeric indicator of positive response. 0 = FALSE or 1 = TRUE}
#'
#'   }
#' @references We need some references
#' @keywords datasets
NA

#' @name Set1
#' @title Set1 dataset
#' @description Set1 dataset
#' @rdname dfSet1
#' @docType data
#' @format a data.frame with 6 observation of the following 4 variables, no NAs
#' \describe{
#'
#' \item{y}{number positive}
#'
#' \item{n}{total number in group \code{tx} x \code{clus}}
#'
#' \item{tx}{treatment 'vac' or 'con'}
#'
#' \item{clus}{cluster ID}
#'
#' }
#' @references We need some references
#' @keywords datasets
NA

#' @name Table6
#' @title Table6 dataset
#' @description Table6 dataset
#' @rdname dfTable6
#' @docType data
#' @format a data.frame with 8 observations of the following 4 variables, no NAs
#' \describe{
#'
#' \item{y}{number positive}
#'
#' \item{n}{total number in group \code{tx} x \code{clus}}
#'
#' \item{tx}{treatment 'a' or 'b'}
#'
#' \item{clus}{cluster ID}
#'
#' }
#' @references Table 1 from Gart (1985)
#' @keywords datasets
NA

#' @name bird
#' @title bird dataset
#' @description bird dataset
#' @docType data
#' @format a data.frame with 6 observations of the following 4 variables, no NAs
#' \describe{
#' \item{y}{number positive}
#' \item{n}{total number in group \code{tx} x \code{all}}
#' \item{tx}{treatment 'vac' or 'con'}
#' \item{all}{all?}
#' }
#' @references we need some references
#' @keywords datasets
NA

#' @name birdm
#' @title birdm dataset
#' @description birdm dataset
#' @docType data
#' @format a data.frame with 6 observations of the following 4 variables, no NAs
#' \describe{
#'
#' \item{y}{number positive}
#'
#' \item{n}{total number in group \code{tx} x \code{all}}
#'
#' \item{tx}{treatment 'vac' or 'con'}
#'
#' \item{all}{all?}
#'
#' }
#' @references we need some references
#' @keywords datasets
NA

#' @name set1
#' @title set1 dataset
#' @description set1 dataset
#' @format a 3 x 4 matrix of data in \code{\link{Set1}}
#' @references we need some references!
#' @keywords datasets
NA

#' @name table6
#' @description table6 dataset
#' @title table6 dataset
#' @format matrix for of data in \code{\link{Table6}}
#' @keywords datasets
NA

#' @name rat
#' @title rat dataset
#' @description rat dataset
#' @format a data.frame with 32 observations of the following 3 variables, no
#'   NAs
#'
#' \describe{
#'
#'   \item{y}{number positive}
#'
#'   \item{n}{total number}
#'
#'   \item{group}{treatment group: 'control' or 'treated'}
#'
#'   }
#' @references Weil's rat data (Table 1 of Rao and Scott)
#' @keywords datasets
NA
ABS-dev/PF documentation built on April 26, 2024, 3:29 p.m.