get_salsa_steps: Get step parameters for SALSA

Description Usage Arguments Details Value See Also Examples

Description

Get step parameters for SALSA

Usage

1
get_salsa_steps(x, include_vector = FALSE, ...)

Arguments

x

numeric vector of counts

...

additional arguments are ignored

Details

This function takes a vector of counts and determines the appropriate step size to use when iterating the count threshold used by SALSA.

Value

list containing "n_start", "step_size", "max_step", and when include_vector=TRUE it includes "n_vector" and "count_vector".

See Also

Other SALSA support functions: get_lower_bound, get_upper_bound

Examples

1
2
3
4
5
6
7
8
library(salsa);
data(oz2_numi_per_cell);

usecounts <- sort(oz2_numi_per_cell$count);
get_salsa_steps(usecounts);

# optionally return the vector of thresholds to use
get_salsa_steps(usecounts, include_vector=TRUE);

jmw86069/salsa documentation built on May 21, 2019, 10:31 a.m.