Minor changes:
validObject
calls are enclosed within assert
.validObject
assert checks on legacy DESeqResults
methods.lfcShrinkType
for legacy DESeqResults
objects.Minor changes:
strMatch
from AcidBase.export
: Reworked methods to use AcidGenerics convention instead of BiocIO.plotDEGHeatmap
to plotDegHeatmap
.plotDEGPCA
to plotDegPca
.plotDEGStackedBar
to plotDegStackedBar
.plotDEGUpset
to plotDegUpset
.plotLFC
to plotLfc
.plotMA
to plotMa
. Now using AcidGenerics instead of BiocGenerics.plotPCA
to plotPca
. Now using AcidGenerics instead of
BiocGenerics.Minor changes:
.data
) instead of
rlang syntactic sugar (!!
/sym
).acid_scale_color_discrete
instead of
autoDiscreteColorScale
and acid_discrete_coord_flip
instead of
acid_coord_flip
.Minor changes:
sanitizeTximportIdentifiers
: Fixed typo in identifier check pattern.New functions:
sanitizeTximportIdentifiers
: New utility function for sanitizing malformed
transcript identifiers returned when importing salmon data generated against
GENCODE-aligned BAM files. We hit this edge case when processing Nanopore
samples using guppy to minimap2 to BAM with samtools. This edge case has also
be observed when importing kallisto data aligned against GENCODE, which also
doesn't currently handle transcript identifier sanitization correctly.Major changes:
Minor changes:
NAMESPACE
.
This has been corrected inside of prepareTximportFiles
to correctly
reference the methods exported in syntactic package.Major changes:
prepareTximportFiles
to work on a directory instead of files.Minor changes:
DFrame
instead of DataFrame
virtual class consitently.deseq
and deseqMinimal
objects.matchMetadataToFiles
function.Minor changes:
requireNamespaces
import from AcidBase to goalie.Major changes:
export
: Reduced the number of exported methods, to match the new conventions
defined by pipette. Note that con
is now required instead of dir
for the
target directory.Minor changes:
Minor changes:
results
: Now defaults to quiet = TRUE
by default, to reduce the amount
of message spam in bcbioRNASeq R Markdown templates.Minor changes:
tempdir2
and unlink2
.Minor changes:
plotMeanAverage
and apeglmContrast
functions from
NAMESPACE, to avoid collisions with updates in bcbioRNASeq package.Major changes:
topTables
as markdownTables
.resultsTables
return to always return as DataFrameList
containing subset DESeqResults
. Previously tbl_df
option was available,
but this has been removed in favor of Bioconductor S4Vectors support instead.export
, markdownTables
, and resultsTables
,
to ensure that we never drop rownames.Minor changes:
resultsTables
and topTables
to work with minimal DESeqDataSet
that doesn't contain gene names and additional metadata in rowData
.plotDEGStackedBar
and plotDEGUpset
to early return with alert
warning for objects without DEGs.deseqMinimal
object, that contains
an unusually small DESeqDataSet
without metadata, which is useful for
testing edge case handling in our plotting functions.Map
instead of mapply
, as recommended by lintr.plotBaseMean
now longer exporting integer
method -- using internally only.Major changes:
Minor changes:
droplevels2
approach, which provides better compatibility with Bioconductor
3.15 release.ggplot
, using as.data.frame
coercion instead
of as_tibble
.New functions:
plotContrastScatter
: Visualize expression between numerator and denominator
for a contrast of interest.plotLFC
: Plot log2 fold change distributions for all contrasts in the
DESeq2 analysis.Major changes:
export
: Updated method to inherit BiocIO conventions now used in basejump,
which now rely on con
argument.as.DESeqDataSet
and as.DESeqTransform
coercion methods.Minor changes:
plotPCA
: Tightned up method export to only work on DESeqAnalysis
object,
so we don't conflict with DESeqTransform
method defined in DESeq2.plotVolcano
: Hardened against edge case where visualization of a specific
gene is requested, but contains a censored adjusted P value.deseq
object.contrastSamples
: Improved documentation.Minor changes:
apeglmResults
: Relaxed assert check on P values when applying adaptive
shrinkage via apeglm model.Minor changes:
plotVolcano
: Bug fix for plot labels not mapping correctly. Expecting
"lfcCol", "negLogAlphaCol" internally, but these were incorrectly mapped
to the values expected for plotMA
instead. Thanks to @kokyriakidis for
noticing this.Minor changes:
rmarkdown::render
call in unit tests.Minor changes:
guide
function defined in ggplot2,
which has deprecated use of logical FALSE
in favor of "none"
.New classes:
DESeqResultsList
: New class and corresponding generator function that
enables quick looping operations across related DESeqResults
objects. This
can be useful instead of DESeqAnalysisList
approach for cases where we
don't have all of the original DESeqDataSet
objects used to generate the
corresponding DESeqResults
, which can happen with commercial sequencing
vendors and analysis platforms.Major changes:
plotMA
and plotVolcano
.
By default, this behavior is unchanged from previous release, but now
limit overrides can be defined similar to the approach in DESeq2 that uses
geneplotter engine internally.Minor changes:
alphaThreshold
and lfcThreshold
return sensible defaults for minimal
DESeqResults
objects created by coercion of a DataFrame
directly.Minor changes:
DESeqAnalysis
: Relaxed check for gene identifiers in mcols
of rowRanges
of nested DESeqDataSet
inside data slot. Resolves issue #61.Minor changes:
Major changes:
[
for DESeqAnalysis
class.
Code works internally similar to method defined for bcbioRNASeq
.rownames
, colnames
,
names
, and dimnames
for DESeqAnalysis
class.Minor changes:
degIntersection
: Added return = "names"
option, which is useful for
generating intersection subset tables.Minor changes:
Minor changes:
extra
mode internal code from resultsTables
directly into
results
, so we can hand-off to new methods defined in acidgsea package
that depend on DESeqResults
object (i.e. geneSetResults
). The
resultsTables
function still behaves the same as previous releases.plotDEGStackedBar
: Added support for orderBySize
argument.degPerContrast
: Removed unnecessary n
argument; use return
instead.Minor changes:
results
: Bug fix for logical check on lfcShrink
return. The internal
use of identical
here is too strict, as lfcShrink
can return cause
attribute from goalie.lfcShrink
: Hardened logical return, ensure goalie cause attribute removal.Minor changes:
plotDEGPCA
: Updated internal title
and subtitle
handoff to plotPCA
.plotDEG*
functions. This information is shown in
the plots and doesn't need to be messaged.Minor changes:
degIntersection
: Bug fix for column names not returning as expected.New functions:
degIntersection
: Utility function that will return the number of times a
DEG is detected across contrasts.Minor changes:
apeglmResults
: Simplified default arguments and disabled ...
passthrough
to lfcShrink
, which is a bit confusing. Note that DESeq
and lfcShrink
are now called internally with parallel = TRUE
.Minor changes:
i
argument support to degPerContrast
, and the plotting functions
plotDEGUpset
and plotStackedBar
, which call degPerContrast
internally.
This allows the user to pick specific contrasts of interest to plot.plotDEGStackedBar
: Now allowing the user to pick only up- or down-regulated
genes, which can be useful.apeglmResults
cli display code.Minor changes:
Major changes:
DESeqAnalysis
object now supports stashing of threshold metadata:alphaThreshold
.lfcShrink
: whether to use (adaptie) shrunken LFC values or not.lfcThreshold
(for post-hoc cutoffs).baseMeanThreshold
.
These are defined in the metadata
slot of the object and can be accessed/
modified with corresponding S4 generics.alpha_threshold
base_mean_threshold
contrast_samples
lfc_shrink
lfc_threshold
Minor changes:
Major changes:
baseMeanThreshold
, where applicable. Applies primarily
to deg
, plotDEGHeatmap
, plotDEGPCA
, plotMA
, and plotVolcano
,
and resultsTables
.lfcThreshold
and baseMeanThreshold
now use >=
logic rather than previous >
approach.
The alpha cutoff still uses >
operator logic.Minor changes:
Minor changes:
setValidity
call separately from setClass
.updateObject
: FGSEAList
method now uses ...
and verbose
arguments,
as defined in the S4 generic.Minor changes:
Minor changes:
New functions:
combine
: Method support for combining multiple results contrasts into a
single DESeqAnalysis
object. Note that the internal DESeqDataSet
and
DESeqTransform
objects defined in x
and y
must match.New functions:
resultsDiff
: Compare the effect difference between two DESeqResults
contrasts. Useful for evaluating the relative effect of compounds, RNAi
clones, CRISPR guides, for example.Minor changes:
contrastSamples
: Added support for interaction effect (difference of
differences) contrasts. For example: "group_B_vs_A_group_C_vs_A_effect".plotCounts
: Added samples
argument support for DESeqAnalysis
method.
This is useful for quick sample selection when generating plots.lfcShrink
handling in results
calls.
Note that reuslts
still defaults to lfcShrink = FALSE
, whereas other
plotting and results table functions default to lfcShrink = TRUE
.deg
: Added alpha and LFC information in message.Minor changes:
alpha
and lfcThreshold
for
these plots: plotDEGHeatmap
, plotDEGPCA
, plotDEGUpset
, plotMA
,
plotVolcano
.Minor changes:
deg
: Fixed DESeqAnalysis
method passthrough to DESeqResults
, allowing
use of alpha
and lfcThreshold
, for post-hoc cutoffs.Minor changes:
apeglmContrast
in favor of modified S4 method approach now
defined in apeglmResults
. The internal code is otherwise unmodified.plotDEGHeatmap
: Simplified argument handling and internal passthrough to
plotHeatmap
SummarizedExperiment
method defined in AcidPlots.Minor changes:
plotCounts
: Added method support for DESeqTransform
. Also added a
transform
argument to DESeqAnalysis
method, which allows the user to
easily plot variance-stabilized counts using the slotted DESeqTransform
object.Major changes:
results
argument to i
for DESeqAnalysis
methods, where
applicable. This improves consistency with Bioconductor conventions (similar
to assay
method, which also uses i
for position). Note that previous
usage of results
is now defunct and should intentionally error.Minor changes:
resultsMatrix
: Added support for baseMean
aggregation, and improved
documentation.plotHeatmap
, plotCorrelationHeatmap
, and plotQuantileHeatmap
method support, which extracts DESeqTransform
object internally and hands
off to SummarizedExperiment
methods defined in AcidPlots.Minor changes:
plotDEGHeatmap
, plotDEGPCA
: Hardened methods against input with very few
DEGs (less than 10). Simplified internal method passthrough to no longer
rely upon matchArgsToDoCall
function.plotBaseMean
: Now exporting numeric
method, which is the basis for
DESeqDataSet
and DESeqResults
methods.New functions:
matchMetadataFiles
: Quickly generate a mapping data frame of user input
metadata sample names to the expected tximport quant directory names
(e.g. salmon, kallisto output). This is useful when a user provides metadata
that doesn't match the FASTQ names exactly.prepareTximportFiles
: Automatically assigns valid sample names to tximport
quant file import. Tested primarily against salmon and kallisto files.New functions:
apeglmContrast
: New utility function that enables lfcShrink
using apeglm
without having to mentally deal with coef
argument.Major changes:
DESCRIPTION
.Minor changes:
plotBaseMean
: Added argument support to define colors and disable summary
statistics lines. Simplified internal passthrough in DESeqAnalysis
,
DESeqDataSet
, and DESeqResults
methods.Minor changes:
DESeqAnalysis
methods now stash contrast name into metadata
as
contrastName
for DESeqResults
objects, which allows for easier contrast
name handling inside plotting and other markdown functions. We needed to add
a new useStash
argument for contrastName
that disables this behavior, so
contrastSamples
can pull the samples from a pairwise contrast easily.New functions:
importPairwiseContrasts
: Quickly import pairwise contrasts definining
numerator and denominator for a specified group.Minor changes:
DataFrame
usage inside plotMA
and plotVolcano
,
using our leftJoin
method internally.Minor changes:
plotMA
and plotVolcano
. Reworked internal
code using base R methods against DataFrame
class instead of tbl_df
.topTables
: Now using DataFrame
-oriented internal code to return the
kable
output, rather than relying upon tbl_df
with dplyr.Minor changes:
New functions:
plotBaseMean
: Quickly visualize the count distribution across all samples.Minor changes:
Minor changes:
Version bump, reflecting change in basejump dependency.
New functions:
plotPCA
: Added improved method support for DESeqTransform
, masking the
method exported in DESeq2. Also added corresponding method support for
DESeqAnalysis
class, which uses DESeqTransform
method internally.Minor changes:
plotMA2
export, which keeps DESeq2 plotMA
method as an alias.New functions:
plotDEGUpset
: Support for easily plotting bidirectional (up/down) DEG
intersections across contrasts, using the UpSetR package.Minor changes:
show
method to include alpha
and lfcThreshold
information.topTables
: Added lfcShrink
support.New functions:
lfcShrinkType
, and transformType
, which were previously used
internally but are generally useful.Major changes:
plotDEGHeatmap
: Improved default color breaks. Now defaults to
blue-black-yellow default color scheme (see AcidPlots::blueYellow
)..matchResults
function in favor of consistently using
results
instead throughout the package.Minor changes:
lfcShrink
into object is now optional again.lfcShrink
argument support to plotDEGHeatmap
, topTables
, and
export
.plotMA
, plotVolcano
: Now suppressing duplicate gene message returned by
internal Gene2Symbol
call, which isn't informative here.lfcThreshold
and lfcShrink
information on plots, where applicable.Minor changes:
resultsMatrix
to an S4 generic and added initial support for
DESeqAnalysis
and DESeqAnalysisList
class objects.Minor changes:
Bug fixes to improve handling of DESeqDataSet
generated using RefSeq gene
annotations.
Minor changes:
contrastNames
: Improved internal regular expression matching to properly
detect a contrast factor prefix that contains an underscore. This now works
by checking against the column names of colData
internally.topTables
: geneID
, geneName
, and geneBiotype
are now optional columns.Major changes:
export
: Removed humanize
argument.plotCounts
: Removed transform
argument.plotDEGHeatmap
, plotDEGPCA
: Removed counts
argument.plotMA
, plotVolcano
: Improved color support and gene-to-symbol handling.Minor changes:
topTables
: Simplifed internal method code for DESeqAnalysis
class.New functions:
resultsMatrix
: Utility function that quickly aggregates DESeqResults
values for multiple contrasts into a single matrix
. Currently supports
return of log2FoldChange
, stat
, or padj
values.Minor changes:
Minor changes:
plotCounts
, plotDEGHeatmap
(i.e. plotHeatmap
), and
plotDEGPCA
(i.e. plotPCA
).acid
prefix instead
of basejump
.Minor changes:
Minor changes:
Minor changes:
plotCounts
: Removed DESeqDataSet
method support, which is now covered
inside SummarizedExperiment
method support in basejump.Major changes:
plotDEGHeatmap
, plotDEGPCA
: Reworked internal code to export
DESeqResults
method that maintains backward compatibility with approach
used in bcbioRNASeq F1000 paper.DESeqResults
method support for plotMA
,
plotVolcano
, resultsTables
, and topTables
, to maintain backward
compatibility with bcbioRNASeq R package.Minor changes:
Minor changes:
resultsTables
, which needs to assign rownames
on rowData
return.This release reworks the S4 class structure and adds DESeqAnalysisList
. Note
that objects previously saved prior to the v0.1.8 release will no longer return
valid when checked using validObject
. They can be updated using
updateObject
.
New classes:
DESeqAnalysisList
: extends SimpleList
, and enables saving of multiple
analyses (e.g. per patient clinical data) in a single object. This class makes
it much easier to report on multiple complex contrasts.Major changes:
DESeqAnalysis
now inherits from Annotated
class. This enables support for
metadata
slot, which can be used to store package version.DESeqAnalysis
validity method.Minor changes:
plotCounts
generic, in favor of now deprecated plotGene
.results
and resultsNames
generics.lfcShrink
type (e.g. apeglm).sampleData
method support for DESeqAnalysis
, thereby simplying
the sample_data
chunk in differential expression R Markdown template.show
method for DESeqAnalysis
. This now will return
the version of DESeqAnalysis and not just DESeq2.deseq
example object.Minor changes:
contrastSamples
: Improved internal sample and contrast name handling.
No longer attempting to force snake case formatting.Minor changes:
results
argument for all DESeqAnalysis
methods, where
applicable. For example, refer to contrastSamples
in this release.sanitizeRowData
from imports..matchResults
assert check, looking for missing
results argument.Major changes:
DataFrame
to tbl_df
coercion methods directly from basejump
instead of the transformer package. Note that S4Transfomer package was
renamed simply to transformer at this date.Minor changes:
DESeqAnalysis-class
and the corresponding
generator function. Refer to the roxygen syntax (e.g. rdname
) on how to
accomplish this, since it is useful across packages that define S4 class.Major changes:
DESeqAnalysis
object.Minor changes:
contrastSamples
and resultsTables
generics (verbs) to bioverbs.validateS4
code, instead relying upon goalie::validate
.bioc-release
.nullOK = TRUE
, where applicable. This was
added in the corresponding release update to goalie.isAlpha
instead of containsAlpha
for assert check.imports.R
file.Major changes:
results = 1L
by default in DESeqAnalysis
methods for
functions that support pulling a DESeqResults
object. This can result in
unwanted behavior, and we shouldn't assume use of first slotted contrast.
Now the user must request the desired contrast explicitly.Minor changes:
plotDEGHeatmap
, plotDEGPCA
,New functions:
contrastSamples
: Experimental. Return the samples used to generate a
corresponding DESeqResults
object. May revise this approach to simply
store the sample names directly in the DESeqResults
in the future.deg
: Utility function to obtain DEG gene vector.resultsTables
: Migrated from bcbioRNASeq. Enables easy output of
directional DEG tables from DESeqResults
object.Major changes:
.matchResults
internal utility to match DESeqResults
.export
.DESeqResultsTables
class.DESeqResults
method for plotDEGHeatmap
, plotDEGPCA
.
May add this back in a future release to maintain compatibility with
bcbioRNASeq workflow paper.Minor changes:
goalie::validate
instead of
assertthat::validate_that
.DESeqAnalysis
S4 data set (deseq
).updateObject
, which must be added in future update.Major changes:
show
method for DESeqResultsTables
class.Minor changes:
Initial release. Some of the functions defined in this package have been migrated from my bcbioRNASeq R package.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.