Join the strata with the data

The function first filters individuals in data then include the strata.

Usage

join_strata(data, strata = NULL, pop.id = FALSE, verbose = TRUE)

Arguments

data

A tidy dataset object. Documented in tidy_genome.

strata

(path or object) The strata file or object. Additional documentation is available in read_strata. Use that function to whitelist/blacklist populations/individuals. Option to set pop.levels/pop.labels is also available. Default: strata = NULL.

pop.id

(logical) When pop.id = TRUE, the strata returns the stratification colname POP_ID. With the default, Returns STRATA. Default: pop.id = FALSE.

verbose

Logical indicating whether progress messages are emitted. Default: verbose = TRUE.

Value

The data filtered by the strata by individuals.

See also

read_strata, summary_strata, individuals2strata, change_pop_names, generate_strata

Author

Thierry Gosselin thierrygosselin@icloud.com

Examples

if (FALSE) { # \dontrun{
data <- genometranslator::join_strata(
    data = my_tidy_dataset_object,
    strata = my_strata_object)
} # }