random_subsampling {AlpsNMR} | R Documentation

## Random subsampling

### Description

Random subsampling

### Usage

    random_subsampling(
      sample_idx,
      iterations = 10L,
      test_size = 0.25,
      keep_together = NULL,
      balance_in_train = NULL
    )

### Arguments

`sample_idx` | Typically a numeric vector with sample index to be separated. A character vector with sample IDs could also be used
`iterations` | An integer, the number of iterations in the random subsampling
`test_size` | A number between 0 and 1. The samples to be included in the test set on each interation.
`keep_together` | Either `NULL` or a factor with the same length as `sample_idx`. `keep_together` can be used to ensure that groups of samples are kept in together in all iterations (either on training or on test, but never split). A typical use case for this is when you have sample replicates and you want to keep all replicates together to prevent overoptimistic results (having one sample on the train subset and its replicate on the test subset would make the prediction easier to guess). Another use case for this is when you have a longitudinal study and you want to keep some subjects in the same train or test group, because you want to use some information in a longitudinal way (e.g. a multilevel plsda model).
`balance_in_train` | Either `NULL` or a factor with the same length as `sample_idx`. `balance_in_train` can be used to force that on each iteration, the train partition contains the same number of samples of the given factor levels. For instance, if we have a dataset with 40 samples of class "A" and 20 samples of class "B", using a `test_size = 0.25`, we can force to always have 16 samples of class "A" and 16 samples of class "B" in the training subset. This is beneficial to those algorithms that require that the training groups are balanced.

### Value

A list of length equal to `iterations`. Each element of the list is a list with two entries (`training` and `test`) containing the `sample_idx` values that will belong to each subset.

### Examples

    random_subsampling(1:100, iterations = 4, test_size = 0.25)

    subject_id <- c("Alice", "Bob", "Charlie", "Eve")
    random_subsampling(1:4, iterations = 2, test_size = 0.25, keep_together = subject_id)

[Package AlpsNMR version 3.0.6 Index]