addedInput schema / properties / avgTxLength
Added value: +{
+ "default": "",
+ "description": "optional: tximport's average transcript lengths (txi$length), the same genes and samples as `counts`. DESeq2 then normalizes by gene-by-sample factors (each gene's lengths over their geometric mean, times median-of-ratios size factors), correcting for changes in transcript usage between samples. Only applies when method is DESeq2.",
+ "type": "string"
+}
addedInput schema / properties / betaPrior
Added value: +{
+ "default": false,
+ "description": "DESeq2's pre-1.16 default: a zero-mean Normal prior on every level's log2 fold change, so the reported fold changes, SEs and Wald test are the shrunken (MAP) ones. Wald only, no interactions; use instead of `shrink`. Only applies when method is DESeq2.",
+ "type": "boolean"
+}
addedInput schema / properties / blind
Added value: +{
+ "default": true,
+ "description": "fit the transformation's dispersion trend under ~ 1, blind to the design (DESeq2's default, for quality assessment); off reuses the fitted design and trend, for downstream use when large differences between groups are expected. Only applies when method is DESeq2.",
+ "type": "boolean"
+}
changedInput schema / properties / fitType / description
Previous value: -"the dispersion trend: parametric (asymptDisp + extraPois / mean, DESeq2's default) or the mean of gene-wise estimates. Only applies when method is DESeq2."New value: +"the dispersion trend: parametric (asymptDisp + extraPois / mean, DESeq2's default, which falls back to local when it does not fit), local (locfit regression of log dispersion on log mean), the mean of gene-wise estimates, or glmGamPoi (gene-wise maximum likelihood by glmGamPoi, a local-median trend and quasi-likelihood shrinkage; with test LRT the p-values are glmGamPoi's quasi-likelihood F test; no outlier replacement, minmu 1e-6, no observation weights). Only applies when method is DESeq2."
changedInput schema / properties / fitType / enum
Previous value: -[
- "parametric",
- "mean"
-]New value: +[
+ "parametric",
+ "local",
+ "mean",
+ "glmGamPoi"
+]
addedInput schema / properties / minmu
Added value: +{
+ "description": "the floor on fitted means in the GLM and the dispersion fit; empty is DESeq2's default, 0.5, or 1e-6 with fitType glmGamPoi. Single-cell counts, often below 1, want a small value such as 1e-6 (zinbwave's vignette). Only applies when method is DESeq2.",
+ "minimum": 0,
+ "type": "number"
+}
addedInput schema / properties / pcaGroup
Added value: +{
+ "default": "",
+ "description": "plotPCA's intgroup: the sample-table variables, separated by commas, that colour the samples (joined with ':' when more than one); empty is the factor of the reported comparison. Only applies when method is DESeq2.",
+ "type": "string"
+}
addedInput schema / properties / pcaTop
Added value: +{
+ "default": 500,
+ "description": "plotPCA's ntop: the PCA uses this many genes with the largest variance of the transformed values. Only applies when method is DESeq2.",
+ "minimum": 2,
+ "type": "number"
+}
changedInput schema / properties / sfType / description
Previous value: -"size factors: median of ratios over genes with no zero (ratio), or with zeros allowed (poscounts, for sparse data). Only applies when method is DESeq2."New value: +"size factors: median of ratios over genes with no zero (ratio), with zeros allowed (poscounts, for sparse data), or iterated to maximise the NB likelihood of all but the worst-fitting 5% of genes (iterate, when every gene has a zero). Only applies when method is DESeq2."
changedInput schema / properties / sfType / enum
Previous value: -[
- "ratio",
- "poscounts"
-]New value: +[
+ "ratio",
+ "poscounts",
+ "iterate"
+]
changedInput schema / properties / shrink / description
Previous value: -"shrink the reported coefficient's log2 fold changes toward zero where the counts cannot support them (DESeq2 lfcShrink), for ranking and plotting by effect size; p-values stay the unshrunken test's. apeglm: adaptive Cauchy prior, posterior mode. ashr: mixture-of-normals prior, posterior mean. normal: DESeq2's original zero-centred Normal prior (Wald only). Only applies when method is DESeq2."New value: +"shrink the reported coefficient's or contrast's log2 fold changes toward zero where the counts cannot support them (DESeq2 lfcShrink), for ranking and plotting by effect size; p-values stay the unshrunken test's. apeglm: adaptive Cauchy prior, posterior mode (a coefficient only). ashr: mixture-of-normals prior, posterior mean. normal: DESeq2's original zero-centred Normal prior (Wald only), a contrast on the expanded model matrix. With lfcThreshold, apeglm and ashr give s-values of a false sign or a fold change inside the threshold, and normal re-tests the shrunken fit. Only applies when method is DESeq2."
addedInput schema / properties / transform
Added value: +{
+ "default": "vst",
+ "description": "the count transformation the sample-level checks (PCA, sample distances) run on: vst (DESeq2's variance stabilizing transformation, the trend fitted on 1,000 genes; with fewer than 1,000 genes above a mean of 5 use VST), VST (varianceStabilizingTransformation, every gene), rlog (regularized log, a per-gene ridge fit, slow above ~30 samples) or normTransform (log2 of normalized count + 1, no stabilization). none skips the checks. Only applies when method is DESeq2.",
+ "enum": [
+ "vst",
+ "VST",
+ "rlog",
+ "normTransform",
+ "none"
+ ],
+ "type": "string"
+}
addedInput schema / properties / useT
Added value: +{
+ "default": false,
+ "description": "Wald p-values from a Student t on each gene's summed weights (or the sample count) minus the coefficients, instead of the normal: zinbwave's recommendation for weighted single-cell data. Wald test only. Only applies when method is DESeq2.",
+ "type": "boolean"
+}
addedInput schema / properties / weights
Added value: +{
+ "default": "",
+ "description": "optional: observation weights (assays(dds)[[\"weights\"]]), the same genes and samples as `counts`, e.g. zinbwave's posterior probability that a single-cell count is not a dropout. DESeq2 divides each gene's weights by their largest and uses them in the base means, the dispersion likelihoods (samples at or below 0.01 leave the Cox-Reid term), the GLM and its tests. Only applies when method is DESeq2.",
+ "type": "string"
+}
changedOutput schema / properties / genes / description
Previous value: -"one row per gene: log2FoldChange, stat (DESeq2 Wald or LRT, edgeR F, voom moderated t), pvalue, padj, why padj is NA, the normalized counts per sample; DESeq2 adds baseMean, lfcSE, the gene-wise, fitted and final dispersions, whether it was refitted and with `shrink` the shrunken fold change, its SE and s-value; edgeR and voom add logCPM, the raw, prior and posterior variance (edgeR's QL dispersion) and the total df, and voom the B-statistic"New value: +"one row per gene: log2FoldChange, stat (DESeq2 Wald or LRT, edgeR F, voom moderated t), pvalue, padj, why padj is NA, the normalized counts per sample; DESeq2 adds baseMean, lfcSE, the gene-wise, fitted and final dispersions, whether it was refitted and with `shrink` the shrunken fold change, its SE and s-value (normal with lfcThreshold: the shrunken fit's p-value and padj); edgeR and voom add logCPM, the raw, prior and posterior variance (edgeR's QL dispersion) and the total df, and voom the B-statistic"
addedOutput schema / properties / sampleDistances
Added value: +{
+ "description": "DESeq2 runs only (null under edgeR and voom): the sample checks as data: the transformation and its trend, the PCA genes, percentVar, PC1 and PC2 per sample, the sample-to-sample Euclidean distance matrix over every gene and its complete-linkage clustering (leaf order, merges, heights), as the vignette's heatmap draws it; or why the checks could not run"
+}
addedOutput schema / properties / samplePca
Added value: +{
+ "description": "DESeq2 runs only (null under edgeR and voom): plotPCA on the transformed counts (`transform`, `blind`): PC2 against PC1 per sample, one series per `pcaGroup` level, each axis labelled with its share of the variance",
+ "properties": {
+ "mark": {
+ "enum": [
+ "line",
+ "bar",
+ "point"
+ ],
+ "type": "string"
+ },
+ "rules": {
+ "items": {
+ "properties": {
+ "label": {
+ "type": "string"
+ },
+ "y": {
+ "type": "number"
+ }
+ },
+ "required": [
+ "y",
+ "label"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "series": {
+ "items": {
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "y": {
+ "items": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "name",
+ "y"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "title": {
+ "type": "string"
+ },
+ "x": {
+ "items": {
+ "type": "number"
+ },
+ "type": "array"
+ },
+ "xLabel": {
+ "type": "string"
+ },
+ "yLabel": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "x",
+ "series",
+ "xLabel",
+ "yLabel"
+ ],
+ "type": [
+ "object",
+ "null"
+ ]
+}
changedOutput schema / required
Previous value: -[
- "genes",
- "summary",
- "significantGenes",
- "upGenes",
- "downGenes",
- "testedGenes",
- "rankedList",
- "maPlot",
- "volcano",
- "dispersionPlot"
-]New value: +[
+ "genes",
+ "summary",
+ "significantGenes",
+ "upGenes",
+ "downGenes",
+ "testedGenes",
+ "rankedList",
+ "maPlot",
+ "volcano",
+ "dispersionPlot",
+ "samplePca",
+ "sampleDistances"
+]