https://github.com/csoneson/dreval
Convenience functions to evaluate reduced dimension representations in SingleCellExperiment objects
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: biorxiv.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.9%) to scientific vocabulary
Repository
Convenience functions to evaluate reduced dimension representations in SingleCellExperiment objects
Basic Info
- Host: GitHub
- Owner: csoneson
- License: other
- Language: R
- Default Branch: master
- Homepage: https://csoneson.github.io/dreval
- Size: 102 MB
Statistics
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
dreval
dreval is an R package aimed at evaluation and comparison of reduced dimension
representations of high-dimensional data. Given one or more reduced dimension
representations, and a "reference" representation (which can be the original,
high-dimensional representation or a baseline low-dimensional one), dreval
will calculate a collection of metrics quantifying how well each of the
evaluated representations recapitulates the structure of the observations in the
reference representation.
Installation
To install dreval, you need the remotes (or devtools) R package, which can
be installed from CRAN. The following commands installs first remotes, then
dreval.
install.packages("remotes")
remotes::install_github("csoneson/dreval")
Application
The input to dreval is a
SingleCellExperiment
object, containing one or more assays and one or more reduced dimension
representation. By default, the logcounts assay will be used as the reference
representation, against which each of the provided reduced dimension
representations will be evaluated. However, any other assay or reduced dimension
representation can be used as the reference data, by setting the arguments to
the dreval() function accordingly.
The package contains a small example single-cell RNA-seq data set with
measurements for approximately 1,800 highly variable genes across 2,700 PBMCs.
The object contains eight reduced dimension representations: 25-dimensional PCA,
2-dimensional PCA, and 2-dimensional t-SNE and 2-dimensional UMAP
representations generated with different values of the perplexity/number of
nearest neighbors. We use the dreval() function to evaluate how well each of
these retain the structure of the cells based on the logcounts assay.
data(pbmc3ksub)
dre <- dreval(sce = pbmc3ksub, refType = "assay",
refAssay = "logcounts", nSamples = 1000, kTM = 50)
For detailed information about the arguments to dreval() we refer to the
help page of the function:
?dreval
The output of dreval() is a list with two elements, named scores and
plots. The scores element is a data.frame with all the calculated evaluation
scores for each of the reduced dimension representations, while the plots
element is a list of diagnostic plots.
The plotRankSummary() function can be used to aggregate the information across
all evaluation metrics. Each reduced dimension representation will be assigned a
rank for each metric, and the sum of these ranks across all metrics, as well as
the contribution from each metric, is visualized by the function. Metrics aimed
at evaluating the preservation of global structure are colored blue, while those
aimed at evaluating the preservation of local structure are colored red.
plotRankSummary(dre$scores)
Related material
- A python framework for reduced dimension representation evaluation was proposed by Heiser and Lau (2019). Code is available on GitHub. This study proposed to use the Mantel correlation between distance matrices, the Earth Mover's Distance between distance distributions, and the percentage of total binary elements of the KNN matrix that are conserved as evaluation metrics.
- The dimRed R package implements a collection of quality scores for reduced dimension representations, including Q_local, Q_global (based on the co-ranking matrix) and various correlation measures.
- The quadra R package implements quality scores for reduced dimension representations based on preservation of neighborhoods and agreement with known labels.
Owner
- Name: Charlotte Soneson
- Login: csoneson
- Kind: user
- Website: http://csoneson.github.io/
- Twitter: CSoneson
- Repositories: 110
- Profile: https://github.com/csoneson
GitHub Events
Total
- Push event: 4
Last Year
- Push event: 4
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Charlotte Soneson | c****n@g****m | 83 |
Issues and Pull Requests
Last synced: over 1 year ago
All Time
- Total issues: 1
- Total pull requests: 1
- Average time to close issues: 13 days
- Average time to close pull requests: about 15 hours
- Total issue authors: 1
- Total pull request authors: 1
- Average comments per issue: 3.0
- Average comments per pull request: 1.0
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- ms609 (1)
Pull Request Authors
- csoneson (1)