dataOverview: dataOverview

In qreport: Statistical Reporting with 'Quarto'

dataOverview

Description

Produce a Data Overview Quarto Section

Usage

dataOverview(
  d,
  d2 = NULL,
  id = NULL,
  plot = c("scatter", "dot", "none"),
  pr = nvar <= 50,
  which = 1,
  dec = 3
)

Arguments

d	a data frame or table
d2	optional second dataset used for analyzing uniqueness of subject IDs
id	optional formula providing names of subject identifiers
plot	specifies type of plot, defaulting to 'scatter'
pr	set to FALSE to omit detailed table and present only graphics
which	when two datasets are given which one should be the focus
dec	certain summary statistics are rounded to the nearest dec places

Details

Produces a multi-tabbed dataset overview as exemplified here. This includes provision of data about data such as variable type, symmetry, missingness, rarest and most common values.

Value

nothing; renders a report with Quarto/RMarkdown

Author(s)

Frank Harrell

Examples

## Not run: 
dataOverview(mydata, secondarydataset)

## End(Not run)

qreport documentation built on May 29, 2024, 3:51 a.m.