characteristic_get: Get metrics for a given characteristic of your dataset.

Description Usage Arguments Value

View source: R/characteristics.R

Description

This function gives similar results to summary().

Usage

1
2
3
4
characteristic_get(data, characteristic, ..., name = NULL,
  events = c(TRUE), quantiles = c("q5", "q25", "q50", "q75", "q95"),
  force_count = FALSE, template = NULL, decimals = eenv_decimals,
  decimals_perc = FALSE)

Arguments

data

A tibble containing the data.

characteristic

The column containing the characteristic to analyse.

...

Subgroups for which to do a separate calculation.

name

The first item in vector (only if a template string is given).

events

The event(s) to count (only if characteristic is not numeric or force_count).

quantiles

The quantiles to collect (default: c("q5", "q25", "q50", "q75", "q95"), only if characteristic is numeric).

force_count

Count frequency of characteristic although its numeric?

template

Apply a template string.

decimals

The number of decimals to display.

decimals_perc

Display decimals for percentages.

Value

A named vector.


randomchars42/eenv documentation built on May 20, 2019, 1:29 p.m.