Releases: insightsengineering/hermes
Releases · insightsengineering/hermes
v1.7.2
v1.7.1
Enhancements
- New plotting function
draw_heatmapto produce heatmaps of (normalized) counts.
Miscellaneous
- The utility function
df_cols_to_factornow also converts existing factors to having explicit missing levels. - Version bump on
forcatsdependency. - Removed
ggplot2deprecation warning..count...
What's Changed
- Add style check workflow by @insights-engineering-bot in #171
- CODEOWNERS removal and pre-commit config by @insights-engineering-bot in #172
- update vignette by @mhallal1 in #173
- 176: fix checkmate test errors by @danielinteractive in #177
- update authors by @pawelru in #178
- Prepare for open sourcing by @cicdguy in #179
- Update .Rbuildignore by @arkadiuszbeer in #180
- 247 coredev docs@pre release by @denisovan31415 in #181
- BS 5 for documentations by @cicdguy in #184
- Update Rbuildignore and add auto-updates by @insights-engineering-bot in #185
- Update pre-commit config to detect
_pkgdown.y[a]mlby @insights-engineering-bot in #186 - Update documentation workflow by @insights-engineering-bot in #187
- Update check.yaml by @arkadiuszbeer in #189
- No if coverage by @arkadiuszbeer in #193
- 190 Add heatmap depicting (normalized) counts by @alexjoerich in #192
- df_cols_to_factor also sanitizes existing factors by @danielinteractive in #194
- 195 remove outdated long file name vdiffr files from snapshots by @alexjoerich in #196
- Add coverage badge by @walkowif in #197
- Enable checks for
workflow_dispatchevent by @walkowif in #198 - Improve user guidance on
rename()by @danielinteractive in #199 - Badges and contribution guidelines by @insights-engineering-bot in #200
- Update README.md by @pawelru in #201
- remove deprecated forcats function; vbump dep by @pawelru in #202
- Update pkgdown configuration by @walkowif in #204
- Update token name by @walkowif in #205
- Update workflows by @walkowif in #207
- 206 Warning about the deprecated syntax
..count..by @moronip81 in #208 - reduce the amount of spelling issues / WORDLIST by @m7pr in #210
- Workflow propagations by @walkowif in #211
- 209: Fix integration check failures by @danielinteractive in #212
- 213: fix binding by @danielinteractive in #214
- Workflow propagation by @walkowif in #215
- Use token in spelling workflow by @walkowif in #216
- Workflow propagation by @walkowif in #217
- 218: fix bioc devel problems by @danielinteractive in #219
- 220 update snapshots by @BFalquet in #222
- Fix pkgdown redirect by @vedhav in #221
- release 1.7.1 to sync with BioC by @danielinteractive in #223
New Contributors
- @mhallal1 made their first contribution in #173
- @alexjoerich made their first contribution in #192
- @walkowif made their first contribution in #197
- @moronip81 made their first contribution in #208
- @m7pr made their first contribution in #210
- @vedhav made their first contribution in #221
Full Changelog: v0.99.5...v1.7.1
v0.99.5
Meta
- First public release of the
hermespackage. - Submission to BioConductor.
Enhancements
- Better legends on the genes barplot and the correlation heatmap.
- Improved vignette layout using the BioConductor style.
- Additional
versionargument forconnect_biomartto specify an Ensembl version.
Miscellaneous
- New utility function
cut_quantilefor cutting a numeric vector into quantiles. - New utility function
cat_with_newlinefor concatenating and printing with newline. - New check function
check_proportionwhich checks for a single proportion.
v0.1.1
New Features
- New function
draw_scatterplotto produce scatterplots of two genes or gene signatures. - New function
draw_boxplotfor boxplots of gene expression values. - New function
draw_barplotfor barplots of dichotomized gene expression counts into two or three percentile categories. - New helper function
wrap_in_maethat wraps a singleSummarizedExperimentobject into an MAE object. - New method
renamethat makes renaming columns ofrowDataandcolDataas well as assay names in existingSummarizedExperimentobjects much easier, as a step before converting toHermesData. - New method
lapplythat allows user to apply a function on all experiments in aMultiAssayExperiment. - New method
isEmptythat checks whether aSummarizedExperimentobject is empty. - New gene filtering option
n_topin thecalc_pcafunction, which allows filtering genes with greatest variability across samples. - New class
GeneSpecfor specification of genes or gene signatures, see?gene_specfor simple construction. Inclusion of gene signature functionscolPrinComp1andcolMeanZscoresto supplement standard column statistics functions. - New helper function
col_data_with_geneswhich extracts the sample variables saved incolDatatogether with selected gene information as a combined data set. - New helper function
inner_join_cdiscwhich joins genetic with CDISC data sets.
Bug Fixes
normalize()now also works when thehermespackage is not loaded, i.e. you can use it withhermes::normalize().correlate()now also works when there are factor variables in the sample variables of theHermesDataobject.add_quality_flags()does no longer returnNAas the technical failure flags for the samples if there is only a single gene contained in the input, but instead a vector ofFALSEto ensure correct downstream functionality.
Miscellaneous
- Updated
LICENCEandREADMEwith new package references. - The
multi_assay_experimentnow containsHermesDataexperiments, different patient IDs, one experiment with normalized assays, and multiple samples per patient in one experiment. - The main
HermesDataexample is now saved in the package ashermes_data, and the previoussummarized_experimentis still available. Note that patient IDs have been changed in the new version to align with themulti_assay_experiment. - Renaming of required
rowDataandcolDatacolumns to be more consistent with standards and use lowercase snake-case names. - Annotation querying and setting is now more flexible in that it also allows to query more annotations than the required ones.
- Instead of gene starts and ends, the total length of gene exons is now used as the annotation column
size. Corresponding queries from BioMart are used to return this gene size. df_char_to_factorhas been deprecated (and can still be used with a warning) and replaced withdf_cols_to_factor, which also converts logical variables to factor variables.- When providing
SummarizedExperimentobjects containingDelayedMatrixassays to theHermesData()constructor, these are silently converted tomatrixassays to ensure downstream functionality.
v0.1.0
- First release of the
hermespackage, which contains classes, methods and functions to import, quality-check, filter, normalize, and analyze RNAseq counts data for differential expression. hermesis a successor of thernaseqToolsR package. The core functionality is built on the BioConductor ecosystem, especially theSummarizedExperimentclass. New users should first begin by reading the "Introduction tohermes" vignette to become familiar with thehermesconcepts.- Import RNAseq count data into the
hermesready format. - Annotate gene information from the Ensembl database via
biomaRt. - Add quality control (QC) flags to genes and samples.
- Filter and subset the data set.
- Normalize the counts.
- Produce descriptive plots.
- Perform principal components analysis.
- Produce a templated QC Rmd report.
- Perform differential expression analysis.