permutation_test {structToolbox} | R Documentation

## Permutation test class

### Description

Applies a permutation test to a model or model_seq(). The input metric is calculated for all permutations, and can be compared to the results from the unpermuted model to assess model validity.

### Usage

    permutation_test(number_of_permutations = 50, factor_name, ...)

### Arguments

`number_of_permutations` | The number of permutations to run
`factor_name` | The same of the sample_meta column to use
`...` | additional slots and values passed to struct_class

### Value

struct object

### Examples

    I=permutation_test(factor_name='Species')

[Package structToolbox version 1.0.1 Index]