-
Notifications
You must be signed in to change notification settings - Fork 34
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Stephenson datasets #565
Conversation
src/scirpy/datasets/__init__.py
Outdated
"""\ | ||
Return the dataset from :cite:`Maynard2020` as AnnData object. | ||
|
||
21k cells from NSCLC profiled with Smart-seq2, of which 3,500 have :term:`TCRs<TCR>` | ||
and 1,500 have :term:`BCRs<BCR>`. | ||
|
||
{pooch_info} | ||
|
||
The raw FASTQ files have been obtained from `PRJNA591860 <https://www.ebi.ac.uk/ena/browser/view/PRJNA591860>`__ | ||
and processed using the nf-core `RNA-seq pipeline <https://github.com/nf-core/rnaseq>`_ to obtain | ||
gene expression and TraCeR/BraCeR to reconstruct receptors. | ||
|
||
The processed files have been imported and transformed into an :class:`anndata.AnnData` | ||
object using the following script: | ||
|
||
.. code-block:: python | ||
|
||
{processing_code} | ||
""" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MKanetscheider, could you please update the description here?
For the other datasets, there are python scripts that specify exactly how the dataset was processed, e.g. https://github.com/scverse/scirpy/blob/main/src/scirpy/datasets/_processing_scripts/maynard2020.py that are included using the processing_code
reference.
If you don't have something like that, I'm also happy if you just roughly describe as text how the dataset was processed. Because, let's be honest, likely nobody will ever look at it.
But at least citation and the reference to where you downloaded the data should be there :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my bad, you should have received an invite now
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No problem 😄
For now, I just added a verbal description, because the code I used is kinda messy as I used to test a lot of different things in the same file... if at any point the code is required I will clean it up and provide here, of course!
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #565 +/- ##
==========================================
+ Coverage 81.43% 81.64% +0.21%
==========================================
Files 49 49
Lines 4213 4343 +130
==========================================
+ Hits 3431 3546 +115
- Misses 782 797 +15 ☔ View full report in Codecov by Sentry. |
Closes #...