AlexsLemonade / OpenScPCA-analysis

An open, collaborative project to analyze data from the Single-cell Pediatric Cancer Atlas (ScPCA) Portal
Other
9 stars 17 forks source link
openscience single-cell

OpenScPCA-analysis

OpenScPCA is an open, collaborative project to analyze data from the Single-cell Pediatric Cancer Atlas (ScPCA) Portal, which currently holds 500 samples from over 50 pediatric cancer types.

This project aims to:

Platform and Language

The primary platform for the project is Linux, and we're best able to support analyses written in R and Python. The documentation and analyses modules cater to Linux and Mac platforms, and the above languages.

If desired, please file an issue to request Windows support and associated docs.

Contributing

To start contributing:

  1. Please review our Policies.

  2. Fill out the interest form.

  3. Visit Getting Started for first steps.

Communicating

You can ask questions, propose analyses, get help in GitHub Discussions.

You can also join the OpenScPCA community in the #open-scpca channel on our Cancer Data Science Slack.

GitHub Issues are reserved for planned and defined tasks or bug reports. If this is your first time interacting with the project, please post in Discussions.

If you wish to report a security vulnerability, please email us. Do NOT report it in a public forum. See our security policy for more information.

Please see our documentation on Tools for communication for more information.

Documentation

We have comprehensive documentation to help you with various aspects of participating in OpenScPCA - from proposing an analysis, acquiring data, troubleshooting errors to making your first code contribution.

Please refer to it as you work on the project.

OpenScPCA Documentation

Setting up and running analyses

Local Setup

To set up, you will need a Git client, Miniconda, R or Python, and an editor of your choice. Please see our documentation on Technical Setup for detailed instructions to create a local setup.

Accessing Data

Data is publicly available from the ScPCA Portal and from an AWS S3 bucket for OpenScPCA project contributors. We also provide a way to download smaller, simulated data files for you to play with.

Please refer to Getting Access to Data for more details.

Running an analysis module

Each analysis module has a README.md file which contains instructions to run that specific module. Please see the relevant analysis module's README.md for instructions.

Please see our documentation on running an analysis module for more information.