https://github.com/alleninstitute/ace

R Shiny app for comparison of annotations (e.g., cell type assignments)

https://github.com/alleninstitute/ace

Science Score: 67.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
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README
  • Academic publication links
    Links to: zenodo.org
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
    Organization alleninstitute has institutional domain (alleninstitute.org)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (14.4%) to scientific vocabulary
Last synced: 6 months ago · JSON representation

Repository

R Shiny app for comparison of annotations (e.g., cell type assignments)

Basic Info
  • Host: GitHub
  • Owner: AllenInstitute
  • License: other
  • Language: R
  • Default Branch: main
  • Size: 110 MB
Statistics
  • Stars: 3
  • Watchers: 2
  • Forks: 1
  • Open Issues: 9
  • Releases: 2
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

DOI

Annotation Comparison Explorer (ACE)

R Shiny and web-based tool for comparison of annotations such as (i) cell type assignments, (ii) donor metadata (e.g., donor, sex, age), and (iii) cell metadata (e.g., anatomic location, QC metrics). Two primary use cases are (1) comparing user-defined clustering results and mapping results (e.g., after running MapMyCells) for the same set of cells and (2) comparing cell type names between different taxonomies on Allen Brain Map. Additionally, ACE includes a data set comparing cell type names and associated abudance changes between multiple published studies of Alzheimer's disease in dorsolateral prefrontal cortex (see visualizations far below).

Quick start: try the web-based version of ACE or read the ACE preprint on bioRxiv.


main_ACE_app_page_top

How to use

Visit the website

We recommend using the version of this tool hosted on shinyapps.io.

Run locally

For power users, this tool can also be run locally in R Studio by following the steps below.

Setup RStudio

(You only need do this step once). 1. Install R (ideally version 4.2.2) 2. Install RStudio 3. Download the files from this repo in a working directory 4. Set up your R environment to align with the renv.lock file

We recommend using rig for R installation management along with renv for R environment management. After installing rig, you should be able to run these rig commands in a terminal from your working directory to tackle steps #1 and #4: rig add 4.2.2 rig add rtools42 rig rstudio renv.lock This should set up and then launch RStudio with the correct package configurations. (The first two lines of code only need to be run once).

Run the app

  1. In RStudio, open the file ui.R and click the "Run App" button in the upper right corner of the screen
  2. Explore!

The only difference between local and web versions is that the local version can point to locations on your local computer (which in most cases is unnecessary as these can be uploaded on the web version).

Reporting issues or suggestions

Please share any comments, suggestions, bugs, or any other thoughts using the button in the app, or by submitting an issue.

image

License

The license for this package is available on Github at: https://github.com/AllenInstitute/ACE/blob/master/LICENSE

Level of Support

We are actively updating this tool. Community involvement is encouraged through both issues and pull requests.

Example visualizations and Acknowledgements

Confusion matrices

main_ACE_app_page_bottom

Comparing matched cell types across studies of AD

multi_study_comparison_ACE_panel

ACE is supported by the National Institute of Neurological Disorders and Stroke under Award Number U24NS133077 and by the National Institute On Aging under Award Number U19AG060909. The content is solely the responsibility of the authors and does not necessarily represent the official views of the National Institutes of Health.

Owner

  • Name: Allen Institute
  • Login: AllenInstitute
  • Kind: organization
  • Location: Seattle, WA

Please visit http://alleninstitute.github.io/ for more information.

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 19
  • Watch event: 1
  • Issue comment event: 13
  • Push event: 34
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 19
  • Watch event: 1
  • Issue comment event: 13
  • Push event: 34

Committers

Last synced: 11 months ago

All Time
  • Total Commits: 100
  • Total Committers: 1
  • Avg Commits per committer: 100.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 74
  • Committers: 1
  • Avg Commits per committer: 74.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
jeremymiller j****m@a****g 100
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 16
  • Total pull requests: 3
  • Average time to close issues: 4 months
  • Average time to close pull requests: 1 minute
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.63
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 0
  • Average time to close issues: 3 months
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.4
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • jeremymiller (16)
Pull Request Authors
  • jeremymiller (3)
Top Labels
Issue Labels
Pull Request Labels