check_pilot_set_options: Check Pilot set options

Description Usage Arguments Value

View source: R/split_pilot_set.R

Description

Check Pilot set options

Usage

1
2
3
4
5
6
7
check_pilot_set_options(
  pilot_fraction,
  pilot_size,
  group_by_covariates,
  data,
  n_c
)

Arguments

pilot_fraction

numeric between 0 and 1 giving the proportion of controls to be allotted for building the prognostic score (default = 0.1)

pilot_size

alternative to pilot_fraction. Approximate number of observations to be used in pilot set. Note that the actual pilot set size returned may not be exactly pilot_size if group_by_covariates is specified because balancing by covariates may result in deviations from desired size. If pilot_size is specified, pilot_fraction is ignored.

group_by_covariates

character vector giving the names of covariates to be grouped by (optional). If specified, the pilot set will be sampled in a stratified manner, so that the composition of the pilot set reflects the composition of the whole data set in terms of these covariates. The specified covariates must be categorical.

data

data.frame with observations as rows, features as columns

n_c

number of control observations in data

Value

nothing


raikens1/stratamatch documentation built on May 27, 2021, 10:13 p.m.