Counternull (version 0.2.12)

find_counternull_values: Find Counternull Values

Description

Retrieves counternull value set and returns object of "counternull" class.

Usage

find_counternull_values(null_r, counts = NULL, width = NULL, bw = NULL)

Value

Class "counternull" with 6 entries:

counternull_perm

Counternull test statistics for first counternull set

low

Counternull test statistics for second counternull set

high

Lower bound of counternull set

counternull_perm_two

Upper bound of counternull set

low_two

Lower bound of second counternull set

high_two

Upper bound of second counternull set

null_rand

Specified "null_rand" object

bw

Specified bin width

Arguments

null_r

"null_rand" object corresponding to data

counts

Vector containing lower and upper bounds for number of test statistics more extreme than observed test statistic in counternull randomization distribution (optional)

width

Integer indicating the number of values to search for to retrieve counternull set. Default value = 10000. (Increasing this argument may result in additional counternull values being found.) (optional)

bw

Histogram bin width (optional)

Details

Call summary on "counternull" class to retrieve range of counternull values. Call plot on "counternull" class for visualization of counternull distribution.

Argument "counts" must contain whole numbers for bounds.Lower bound must be smaller than upper bound. If argument is not specified, counternull values will be obtained using the "counts" argument from the specified "null_rand" argument.

If no counternull values are found, all entries in class are set to null. If only one set of counternull values are found, "perm_two", low_two" and "high_two" are set to null.

References

tools:::Rd_expr_doi("10.1111/j.1467-9280.1994.tb00281.x")

Examples

# \donttest{
n_r = create_null_rand(sample_data$turn_angle, sample_data$w,
sample_matrix, test_stat = c("diffmeans"))
c = find_counternull_values(n_r)
summary(c)
plot(c)
c = find_counternull_values(n_r, c(56,60))
summary(c)
# }