R/dataset_documentation.R

In christian-gische/causalSEM: Analyze Causal Effects Using Interventional Distributions

## Changelog:
# MH 0.0.1 2022-02-11: initial test documentation

# https://stackoverflow.com/questions/2310409/how-can-i-document-data-
#                                                             sets-with-roxygen

#' Example data
#'
#' A dataset containing some data. The variables are as follows:
#'
#' \itemize{
#'   \item x1
#'   \item y1
#'   \item x2
#'   \item y2
#'   \item x3
#'   \item y3
#' }
#'
#' @docType data
#' @references Gische, C., Voelkle, M.C. (2021) Beyond the mean: a flexible 
#' framework for studying causal effects using linear models. Psychometrika 
#' (advanced online publication). https://doi.org/10.1007/s11336-021-09811-z
#' @keywords datasets
#' @name d_100
#' @usage data(d_100)
#' @format A data frame with 100 rows and 6 variables
NULL