Skip to content

Commit

Permalink
Generate a readme file for portal metadata in test_data/reamdes/PORTA…
Browse files Browse the repository at this point in the history
…L_ALL_METADATA.md
  • Loading branch information
nozomione committed Sep 11, 2024
1 parent e938747 commit 3329a5e
Showing 1 changed file with 53 additions and 0 deletions.
53 changes: 53 additions & 0 deletions api/test_data/readmes/PORTAL_ALL_METADATA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
Generated on: TEST_TODAYS_DATE

# Alex's Lemonade Stand Foundation Single-cell Pediatric Cancer Atlas

The [Single-cell Pediatric Cancer Atlas](https://scpca.alexslemonade.org) is a database of single-cell and single-nuclei data from pediatric cancer clinical samples and xenografts, built by the [Childhood Cancer Data Lab](https://www.ccdatalab.org/) at [Alex's Lemonade Stand Foundation](https://www.alexslemonade.org/).

## Contents

This download includes associated metadata for samples from all projects currently available at time of download in the ScPCA portal.

The metadata included in this download contains sample, library, and project-related metadata (e.g., age, sex, diagnosis, sequencing unit, etc.) along with any relevant processing metadata (e.g., software versions, filtering methods used, etc.).

See the [Downloadable files](https://scpca.readthedocs.io/en/stable/download_files.html) section in our documentation for more detailed information on files included in the download.

## CHANGELOG

A summary of changes impacting downloads from the ScPCA Portal is available in [the CHANGELOG section of our documentation](https://scpca.readthedocs.io/en/stable/CHANGELOG.html).

## Contact

If you identify issues with this download, please [file an issue on GitHub.](https://github.com/AlexsLemonade/scpca-portal/issues/new) If you would prefer to report issues via e-mail, please contact us at [[email protected]](mailto:[email protected]).

## Citation

If you use these data in your research, you must cite:
- The data submitter using language provided as part of the project abstract (as applicable), the publication listed for the project (as applicable), or both.
- The ScPCA Portal using the language below.

For more information, please see [the How to Cite section of our documentation](https://scpca.readthedocs.io/en/stable/citation.html).

### Citing this project

To cite data from PROJECT_ID_0, please see the project abstract and publication information at [PROJECT_ID_0 page.](https://scpca.alexslemonade.org/projects/PROJECT_ID_0)
To cite data from PROJECT_ID_1, please see the project abstract and publication information at [PROJECT_ID_1 page.](https://scpca.alexslemonade.org/projects/PROJECT_ID_1)
To cite data from PROJECT_ID_2, please see the project abstract and publication information at [PROJECT_ID_2 page.](https://scpca.alexslemonade.org/projects/PROJECT_ID_2)

### Citing the ScPCA Portal

When citing the ScPCA Portal, please cite the following preprint:

Hawkins A. G., J. A. Shapiro, S. J. Spielman, D. S. Mejia, D. V. Prasad, et al., 2024 The Single-cell Pediatric Cancer Atlas: Data portal and open-source tools for single-cell transcriptomics of pediatric tumors. _bioRxiv._ https://doi.org/10.1101/2024.04.19.590243

## Terms of Use

In using these data, you agree to our [Terms of Use](https://scpca.alexslemonade.org/terms-of-use).

### Additional Restrictions

|Project ID|Data Usage Restrictions|
|:---------|:----------------------|
|[PROJECT_ID_0](https://scpca.alexslemonade.org/projects/PROJECT_ID_0)|Research or academic purposes only|
|[PROJECT_ID_1](https://scpca.alexslemonade.org/projects/PROJECT_ID_1)|Research or academic purposes only|
|[PROJECT_ID_2](https://scpca.alexslemonade.org/projects/PROJECT_ID_2)|Research or academic purposes only|

0 comments on commit 3329a5e

Please sign in to comment.