SampleDescription: 'SampleDescription'

In Displayr/flipFormat: Formatting of R outputs

SampleDescription

Description

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

Usage

SampleDescription(
  n.total,
  n.subset,
  n.estimation,
  subset.label,
  weighted = TRUE,
  weight.label = "",
  missing,
  imputation.label = NULL,
  m,
  variable.description = "",
  resample = FALSE,
  effective.sample.size = NULL,
  dummy.adjusted = FALSE
)

Arguments

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.
missing	How missing data is to be treated in the analysis. Options are: "Error if missing data", "Exclude cases with missing data", ,and "Imputation (replace missing values with estimates)".
imputation.label	Method used to impute the data.
m	Number of imputaton samples.
variable.description	A char specifying the type of variables being imputed. Used in the description of the imputation that typically appears in a footer.
resample	Whether resampling is used whenever weights are applied.
effective.sample.size	The effective sample size when weights are applied.
dummy.adjusted	Logical to determine if dummy variables have been used in the sample.

Value

character description of sample

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