diff --git a/DESCRIPTION b/DESCRIPTION index 86dfa54d..9179f1d8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -88,5 +88,4 @@ Config/testthat/parallel: true Roxygen: list(markdown = TRUE) Config/Needs/check: stan-dev/cmdstanr Config/Needs/website: easystats/easystatstemplate -LazyData: true Remotes: vincentarelbundock/marginaleffects diff --git a/R/coffee_data.R b/R/data.R similarity index 56% rename from R/coffee_data.R rename to R/data.R index a8ef7d92..23806ea7 100644 --- a/R/coffee_data.R +++ b/R/data.R @@ -1,3 +1,25 @@ +#' @docType data +#' @title Sample data set +#' @name fish +#' @keywords data +#' +#' @description A sample data set, used in tests and some examples. Useful for +#' demonstrating count models (with or without zero-inflation component). It +#' consists of nine variables from 250 observations. +NULL + + +#' @docType data +#' @title Sample dataset from the EFC Survey +#' @name efc +#' @keywords data +#' +#' @description Selected variables from the EUROFAMCARE survey. Useful when +#' testing on "real-life" data sets, including random missing values. This +#' data set also has value and variable label attributes. +NULL + + #' @docType data #' @title Sample dataset from a course about analysis of factorial designs #' @name coffee_data @@ -15,8 +37,4 @@ #' - `coffee`: Group indicator, whether participant drank coffee or not #' ("`coffee"` or `"control"`). #' - `alertness`: The participant's alertness score. -#' -#' @examples -#' # Attach coffee-data -#' data(coffee_data) NULL diff --git a/R/efc.R b/R/efc.R deleted file mode 100644 index 44b88683..00000000 --- a/R/efc.R +++ /dev/null @@ -1,20 +0,0 @@ -#' @docType data -#' @title Sample dataset from the EUROFAMCARE project -#' @name efc -#' @keywords data -#' -#' @description An SPSS sample data set, imported with the [`datawizard::data_read()`] -#' function. Consists of 28 variables from 908 observations. The data set is part -#' of the EUROFAMCARE project, a cross-national survey on informal caregiving in -#' Europe. -#' -#' @examples -#' # Attach EFC-data -#' data(efc, package = "modelbased") -#' -#' # Show structure -#' str(efc) -#' -#' # show first rows -#' head(efc) -NULL diff --git a/R/fish.R b/R/fish.R deleted file mode 100644 index fb1bb02a..00000000 --- a/R/fish.R +++ /dev/null @@ -1,9 +0,0 @@ -#' @docType data -#' @title Sample data set -#' @name fish -#' @keywords data -#' -#' @description A sample data set, used in tests and some examples. Useful for -#' demonstrating count models (with or without zero-inflation component). It -#' consists of nine variables from 250 observations. -NULL diff --git a/man/coffee_data.Rd b/man/coffee_data.Rd index ff8bc932..4e4f483d 100644 --- a/man/coffee_data.Rd +++ b/man/coffee_data.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/coffee_data.R +% Please edit documentation in R/data.R \docType{data} \name{coffee_data} \alias{coffee_data} @@ -19,8 +19,4 @@ The data consists of five variables from 120 observations: \item \code{alertness}: The participant's alertness score. } } -\examples{ -# Attach coffee-data -data(coffee_data) -} \keyword{data} diff --git a/man/efc.Rd b/man/efc.Rd index aeaedff0..69755add 100644 --- a/man/efc.Rd +++ b/man/efc.Rd @@ -1,23 +1,12 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/efc.R +% Please edit documentation in R/data.R \docType{data} \name{efc} \alias{efc} -\title{Sample dataset from the EUROFAMCARE project} +\title{Sample dataset from the EFC Survey} \description{ -An SPSS sample data set, imported with the \code{\link[datawizard:data_read]{datawizard::data_read()}} -function. Consists of 28 variables from 908 observations. The data set is part -of the EUROFAMCARE project, a cross-national survey on informal caregiving in -Europe. -} -\examples{ -# Attach EFC-data -data(efc, package = "modelbased") - -# Show structure -str(efc) - -# show first rows -head(efc) +Selected variables from the EUROFAMCARE survey. Useful when +testing on "real-life" data sets, including random missing values. This +data set also has value and variable label attributes. } \keyword{data} diff --git a/man/fish.Rd b/man/fish.Rd index 31405fa3..55ef2ca3 100644 --- a/man/fish.Rd +++ b/man/fish.Rd @@ -1,5 +1,5 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/fish.R +% Please edit documentation in R/data.R \docType{data} \name{fish} \alias{fish}