pt_ex_nums: Quick ptables for numeric variables

View source: R/pt_examples.R

pt_ex_numsR Documentation

Quick ptables for numeric variables

Description

pt_ex_nums() returns a perturbation table objects from create_num_ptable() with some default parameters. This is useful for quickly creating ptables to demonstrate usage in other tools.

Usage

pt_ex_nums(parity = TRUE, separation = FALSE)

Arguments

parity

a scalar logical; if TRUE, a single ptable will be generated. If FALSE, two ptables for even and odd numbers are created

separation

a scalar logical; if TRUE, an additional ptable with variance 1 will be returned that is designed to perturb small cell values

Value

Returns a ptable object if both parity and separation are FALSE, else a named list.

Examples


# extra ptable for small cells
names(pt_ex_nums(parity = FALSE, separation = TRUE))

# different ptables for even/odd cells
names(pt_ex_nums(parity = TRUE, separation = TRUE))


ptable documentation built on March 7, 2023, 7:30 p.m.