Skip to content

Commit

Permalink
version bump, rebuild docs, and NEWS update
Browse files Browse the repository at this point in the history
  • Loading branch information
joshua-d-campbell committed Oct 10, 2021
1 parent 1fbef43 commit f0cb48b
Show file tree
Hide file tree
Showing 339 changed files with 89,662 additions and 89,665 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: singleCellTK
Type: Package
Title: Comprehensive and Interactive Analysis of Single Cell RNA-Seq Data
Version: 2.2.1
Version: 2.2.2
Authors@R: c(person(given="Yichen", family="Wang", email="[email protected]", role=c("aut", "cre"),
comment = c(ORCID = "0000-0003-4347-5199")),
person(given="Irzam", family="Sarfraz", email="[email protected]", role=c("aut")),
Expand Down
9 changes: 9 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
Changes in Version 2.2.2 (2021-10-10)

* Several enhancements, refactors, and bug fixes to the UI
* Refactor documentation and pkgdown site
* Added tutorials for R console analysis
* Updates to the UMAP generation in the SCTK-QC pipeline
* Addition of VAM to Pathway prediction tab
* Bug fix to the mitochondrial gene set functions

Changes in Version 2.1.3 (2021-05-14)

* Added diffAbundanceFET and plotClusterAbundance function
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
[![codecov](https://codecov.io/gh/compbiomed/singleCellTK/branch/master/graph/badge.svg)](https://codecov.io/gh/compbiomed/singleCellTK)
<!-- badges: end -->

The Single Cell ToolKit (SCTK) is an analysis platform that provides an **R interface to several popular single-cell RNA-sequencing (scRNAseq) data preprocessing, quality control, and visualization tools**. SCTK imports raw or filtered counts from various scRNAseq technologies and upstream tools such as 10x CellRanger, BUStools, Optimus, STARSolo, and more. By integrating several publicly available tools written in R as well as Python, SCTK performs extensive quality control measures including doublet detection and batch effect correction. Additionally, SCTK summarizes results and related visualizations in a comprehensive R markdown and/or HTML report. SCTK provides a standardized single cell analysis workflow by representing the counts data and the results using the [SingleCellExperiment](https://www.bioconductor.org/packages/release/bioc/html/SingleCellExperiment.html) R object. Furthermore, SCTK enables seamless downstream analysis by exporting data and results in flat .txt and Python Anndata formats.

A comprehensive list of available functions is listed in the Reference section. More information about the toolkit can be found at the toolkit [homepage](https://camplab.net/sctk/).
The Single Cell ToolKit (SCTK) is an analysis platform that provides an **R interface to several popular single-cell RNA-sequencing (scRNAseq) data preprocessing, quality control, analysis, and visualization tools**. SCTK imports raw or filtered counts from various scRNAseq preprocessing tools such as 10x CellRanger, BUStools, Optimus, STARSolo, and more. By integrating several publicly available tools written in R or Python, SCTK can be used to perform extensive quality control including doublet detection, ambient RNA removal, and batch effect correction. SCTK integrates analysis workflows from popular tools such as Seurat and Bioconductor/OSCA into a single unified framework. Results from various workflows can be summarized and easily shared using comprehensive HTML reports. Lastly, data can be exported to Seurat or AnnData object to allow for seamless integration with other downstream analysis workflows. More information about the toolkit can be found at the toolkit [homepage](https://camplab.net/sctk/).

## Installation

Expand All @@ -26,4 +24,4 @@ Tools from both R and Python can be seamlessly integrated within the same analys

## Report Issues

If you face any difficulty in installing or using the toolkit or have identified a bug in the toolkit, please feel free to open up a [GitHub Issue](https://github.com/compbiomed/singleCellTK/issues).
If you face any difficulty in installing or have identified a bug in the toolkit, please feel free to open up an [Issue](https://github.com/compbiomed/singleCellTK/issues) on GitHub. Questions about how to best analyze your scRNA-seq data can be asked in the [Discussions](https://github.com/compbiomed/singleCellTK/discussions) page on GitHub.
6 changes: 3 additions & 3 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -224,11 +224,11 @@ navbar:
href: articles/articles/visualization.html
- text: "Generic Heatmap"
href: articles/articles/heatmap.html
- text: "Tutorial"
- text: "Tutorials"
menu:
- text: "Console Analysis Tutorial"
- text: "Analysis of PBMC3K (R Console)"
href: articles/articles/console_analysis_tutorial.html
- text: "SCTK-QC Pipeline"
- text: "SCTK-QC"
href: articles/articles/cmd_qc.html
- text: "Reference"
href: reference/index.html
Expand Down
Loading

0 comments on commit f0cb48b

Please sign in to comment.