BaseDescription: 'BaseDescription'

In Displayr/flipFormat: Formatting of R outputs

BaseDescription

Description

Describes the sample, for use as footers in multivariate analyses.

Usage

BaseDescription(
  description.of.n,
  n.total,
  n.subset,
  n.estimation,
  subset.label,
  weighted = TRUE,
  weight.label = "",
  resample = FALSE,
  effective.sample.size = NULL
)

Arguments

description.of.n	A description of the sample (e.g., "People").
n.total	Total number of observations in the database.
n.subset	Total number of observations in the subset (less than or equal to n.total).
n.estimation	The total number of observations used in estimation (less than or equal to subset).
subset.label	E.g., "Males living in New York".
weighted	Whether sample has been weighted.
weight.label	The label of the weight.
resample	Whether resampling is used whenever weights are applied.
effective.sample.size	The effective sample size when weights are applied.

Displayr/flipFormat documentation built on Aug. 28, 2024, 6:48 p.m.