nullabor (version 0.3.16)

calc_diff: Calculating the difference between true plot and the null plot with the maximum distance.

Description

Calculate the mean distance between the true plot and all the null plots in a lineup, using the provided distance, and then compute the difference between the mean distance of the true plot and the maximum mean distance of the null plots.

Usage

calc_diff(lineup.dat, var, met, pos, dist.arg = NULL, m = 20)

Value

difference between the mean distance of the true plot and the maximum mean distance of the null plots

Arguments

lineup.dat

lineup data to get the lineup

var

a vector of names of the variables to be used to calculate the difference

met

distance metric needed to calculate the distance as a character

pos

position of the true plot in the lineup

dist.arg

a list or vector of inputs for the distance metric met; NULL by default

m

number of plots in the lineup, by default m = 20

Examples

if (require('dplyr')) {
  lineup.dat <- lineup(null_permute('mpg'), mtcars, pos = 1, n = 8)
  calc_diff(lineup.dat, var = c('mpg', 'wt'), met = 'bin_dist',
    dist.arg = list(lineup.dat = lineup.dat, X.bin = 5, Y.bin = 5),
    pos = 1, m = 8)
}

if (require('dplyr')) {
  calc_diff(lineup(null_permute('mpg'), mtcars, pos = 1, n = 8),
            var = c('mpg', 'wt'), met = 'reg_dist',
            dist.arg = NULL, pos = 1, m = 8)
}