defineTableDesc: Define table descriptions

Description Usage Arguments Value Author(s)

View source: R/makeDF.R

Description

Generate the text that describes the content of the tables generated by makeDF.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
defineTableDesc(
  calculateStatistics,
  subsampleSize,
  kfrac,
  kmin,
  obstype,
  aspect,
  minvalue,
  maxvalue,
  permutationPvalues,
  nPermutations,
  nDatasets
)

Arguments

calculateStatistics

Whether or not statistics and p-values are calculated

subsampleSize

The number of observations for which certain (time-consuming) statistics will be calculated

kmin, kfrac

For statistics that require the extraction of k nearest neighbors of a given point, the number of neighbors will be max(kmin, kfrac * nrow(df))

obstype

The type of observation (e.g., sample, feature, sample pair)

aspect

The name of the aspect of interest

minvalue, maxvalue

The minimal and maximal value of the aspect of interest, used for scaling of the x axis when calculating the area between the eCDFs

permutationPvalues

Whether or not to calculate p-values of statistics via permutation

nPermutations

The number of permutations (only used if permutationPvalues = TRUE)

nDatasets

The number of data sets that are being compared

Value

A list with two text strings in markdown format: one for tables based on a single data column, and one for tables based on two data columns

Author(s)

Charlotte Soneson


countsimQC documentation built on Feb. 5, 2021, 2:02 a.m.