permute_resids_trait: Residual permutation

View source: R/residual_permutation_function.R

permute_resids_traitR Documentation

Residual permutation

Description

Residual permutation

Usage

permute_resids_trait(
  pheno,
  trait,
  covariates_string,
  seed = NULL,
  outcome_type = "continuous"
)

Arguments

pheno

A data.frame of phenotypes/variables

trait

A continuous/binary variable to permute while preserving association with covariates

covariates_string

Covariates to adjust for, as a string used in regression model

seed

Random seed

outcome_type

continuous and binary, default is continuous

Value

Vector of trait values after residual permuted

Examples

data(phenotype)
trait<-"Trait.1"; covars="Age+Sex"
permute_resids_trait(pheno=phenotype, trait=trait,
                     covariates_string=covars, 
                     seed = NULL, outcome_type="continuous")

nkurniansyah/Olivia documentation built on July 29, 2023, 9:10 a.m.