get.summary: get summary function

Description Usage Arguments

Description

this is a wrapper for the summary function, returns a data frame

Usage

1
2
3
get.summary(level = NULL, strata_data = NULL, t = TRUE, maxsum = NULL,
  force_na = TRUE, include_n = TRUE, include_p = FALSE, p_digits = 0,
  name = level, data, verbose = FALSE)

Arguments

level

the strata level to use when subsetting data based on strata_data, defaults to NULL

strata_data

the grouping data, defaults to NULL

t

logical, if TRUE the matrix is transposed before made into a data frame. defaults to TRUE

maxsum

determines the maximum number of levels shown for qualitative variables, defaults to NULL

force_na

logical, if TRUE the number of NAs is reported even if there are none, defaults to TRUE

include_n

logical, if TRUE the number of observations is included, defaults to TRUE

include_p

logical, if TRUE the percentage is also included, defaults to FALSE

p_digits

integer, if include_p = TRUE this will be the number of digits in the percentage, defaults to 0

name

(col)name of data, defaults to level

data

the data to be summarised, no default

verbose

logical, if TRUE more is printed to console, defaults to FALSE


martingerdin/beehive documentation built on May 16, 2019, 11:12 p.m.