inner_split: Inner split of the analysis set for fitting a post-processor

View source: R/inner_split.R

inner_splitR Documentation

Inner split of the analysis set for fitting a post-processor

Description

Inner split of the analysis set for fitting a post-processor

Usage

inner_split(x, ...)

## S3 method for class 'mc_split'
inner_split(x, split_args, ...)

## S3 method for class 'group_mc_split'
inner_split(x, split_args, ...)

## S3 method for class 'vfold_split'
inner_split(x, split_args, ...)

## S3 method for class 'group_vfold_split'
inner_split(x, split_args, ...)

## S3 method for class 'boot_split'
inner_split(x, split_args, ...)

## S3 method for class 'group_boot_split'
inner_split(x, split_args, ...)

## S3 method for class 'val_split'
inner_split(x, split_args, ...)

## S3 method for class 'group_val_split'
inner_split(x, split_args, ...)

## S3 method for class 'time_val_split'
inner_split(x, split_args, ...)

## S3 method for class 'clustering_split'
inner_split(x, split_args, ...)

## S3 method for class 'apparent_split'
inner_split(x, ...)

Arguments

x

An rsplit object.

...

Not currently used.

split_args

A list of arguments to be used for the inner split.

Details

rsplit objects live most commonly inside of an rset object. The split_args argument can be the output of .get_split_args() on that corresponding rset object, even if some of the arguments used to create the rset object are not needed for the inner split.

  • For mc_split and group_mc_split objects, inner_split() will ignore split_args$times.

  • For vfold_split and group_vfold_split objects, it will ignore split_args$times and split_args$repeats. split_args$v will be used to set split_args$prop to 1 - 1/v if prop is not already set and otherwise ignored. The method for group_vfold_split will always use split_args$balance = NULL.

  • For boot_split and group_boot_split objects, it will ignore split_args$times.

  • For val_split, group_val_split, and time_val_split objects, it will interpret a length-2 split_args$prop as a ratio between the training and validation sets and split into inner analysis and inner assessment set in the same ratio. If split_args$prop is a single value, it will be used as the proportion of the inner analysis set.

  • For clustering_split objects, it will ignore split_args$repeats.

Value

An rsplit object.


tidymodels/rsample documentation built on Sept. 29, 2024, 10:48 p.m.