benchmark_nm: Benchmark the amount of RAM needed per permutation in a null...

View source: R/calculate_max_perm_per_core.R

benchmark_nmR Documentation

Benchmark the amount of RAM needed per permutation in a null model

Description

Benchmark the amount of RAM needed per permutation in a null model

Usage

benchmark_nm(phenotype, covariates, benchmark_size = 1000)

Arguments

phenotype

A phenotype file read into R from standard PLINK phenotype format (see (PLINK documentation), with labeled columns for FID, IID, and trait.

covariates

A covariate file read into R from either standard PLINK covariate format ((PLINK documentation) or in a '.csv' with headers for genotype ID (in the first column) and an ID for each covariate (subsequent columns)

benchmark_size

The number of permutations to be used for the benchmark

Value

Integer, the amount of RAM needed per permutation in a null model (in bytes)

Examples

data("small_phenodata")
data("small_covariates")

nm_RAM_per_perm <- benchmark_nm(phenotype = small_phenodata,
                                covariates = small_covariates,
                                benchmark_size = 1000)


naglemi/mtmcskat documentation built on Aug. 23, 2023, 5:35 p.m.