createParamTable: Create a table of parameters that will be used for...

Description Usage Arguments Value

View source: R/utils.R

Description

Create a table of parameters that will be used for simulations

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
createParamTable(
  nreps,
  clus,
  fc,
  ncases = 10,
  nctrls = 10,
  nbatches = 4,
  b_scale = 1,
  s_scale = 1,
  cf_scale = 1,
  res_use = 1.2,
  cond_induce = "cases",
  save_path
)

Arguments

nreps

Numeric value indicating the number of replicates of a simulation that will be run.

clus

The name of the cluster in which a fold change will be induced.

fc

The magnitude of the fold change that will be induced in the chosen cluster. If no fold change is desired, set fc = 1.

ncases

The number of cases.

nctrls

The number of controls.

nbatches

The number of batches that samples will be distributed into.

b_scale

The magnitude of batch-associated gene expression variation the simulated dataset will exhibit. Setting b_scale = 1 will result in realistic levels of batch-associated variation (as derived from parameter estimation of the input dataset). Increasing b_scale results in higher variation, while decreasing b_scale results in lower variation.

s_scale

The magnitude of sample-associated gene expression variation the simulated dataset will exhibit. Setting s_scale = 1 will result in realistic levels of sample-associated variation (as derived from parameter estimation of the input dataset). Increasing s_scale results in higher variation, while decreasing s_scale results in lower variation.

cf_scale

The magnitude of cell state frequency variation that cell states will exhibit across samples in the simulated dataset. Setting cf_scale = 1 will result in realistic levels of cell state frequency variation (as derived from parameter estimation of the input dataset). Increasing cf_scale results in higher variation, while decreasing cf_scale results in lower variation.

res_use

The resolution that will be used for clustering (Louvain method) the simulated dataset.

cond_induce

The condition you wish to induce a fold change in. Setting cond_induce = "cases" will induce a fold change into cases, while setting cond_induce = "ctrls" will induce a fold change into controls.

save_path

The name of the directory the results will be saved to.

Value

A data.frame containing user-controlled parameters that will be used for simulations


immunogenomics/scpost documentation built on July 28, 2021, 4:03 a.m.