R/examples-index.R

In R4VN: Health Data Analysis and Publication-Ready Reporting

#' R4VN Example Cookbook
#'
#' A central index of practical examples. The detailed examples are also merged
#' into the individual help pages, so use `?labvar`, `?tab`, `?ttest`,
#' `?ranksum`, and the corresponding command name while working.
#'
#' @section Data workflow:
#' `usedf()` sets active data. `opendata()` and `savedata()` import and export.
#' `appenddata()` stacks observations; `mergedata()` joins by keys. `keepvar()`,
#' `dropvar()`, `ordervar()`, `renvar()`, `genvar()`, `replacevar()`, and
#' `labvar()` edit active or explicit data.
#'
#' @section Statistical workflow:
#' `tab1()` and `sum1()` provide quick console checks, including nested `by`
#' stratification. `describe()` shows active-data structure. `tab()` and
#' `tabmulti()` produce publication tables. `ttest()` includes
#' one-sample, independent, and paired t tests. `ranksum()`, `signrank()`,
#' `kwallis()`, and `friedman()` provide the principal nonparametric tests.
#' `swilk()` assesses normality. `corr()`, `regress()`, `logistic()`, and
#' `poisson()` provide correlation and regression models.
#' `tabsurv()` and `tabmeta()` provide complete one-command survival and
#' meta-analysis reports; their help pages contain scenario-based cookbooks.
#'
#' @section Graph workflow:
#' `gbar()`, `ghist()`, `gbox()`, `gscatter()`, `gline()`, `gdensity()`, and
#' `gpie()`, `gforest()`, and `groc()` use base graphics and return reusable
#' `r4vn_graph` objects.
#'
#' @name R4VN_examples
#' @examples
#' \donttest{
#' # Discover all examples attached to a command
#' example(labvar)
#' example(ttest)
#' example(ranksum)
#' example(tab1)
#' example(sum1)
#' example(describe)
#' example(signrank)
#' example(kwallis)
#' example(friedman)
#' example(swilk)
#' example(tabmeta)
#'
#' # Open the full help pages
#' help("labvar", package = "R4VN")
#' help("tabmeta", package = "R4VN")
#' help("R4VN_examples", package = "R4VN")
#'
#' }
NULL