Skip to content
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

Merged
merged 4 commits into from
Oct 22, 2024
Merged

Add Stephenson datasets #565

merged 4 commits into from
Oct 22, 2024

Conversation

grst
Copy link
Collaborator

@grst grst commented Oct 20, 2024

Closes #...

  • CHANGELOG.md updated
  • Tests added (For bug fixes or new features)
  • Tutorial updated (if necessary)

Comment on lines 133 to 151
"""\
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}
"""
Copy link
Collaborator Author

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 :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi I just wanted to push my changes to this PR, but apparently my access was denied.
image
Do you know if that's a problem on my side, or do you have to give some kind of permission? 🥲

Copy link
Collaborator Author

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

Copy link
Collaborator

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!

Copy link

codecov bot commented Oct 20, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 81.64%. Comparing base (08e0cc3) to head (2c3e97a).
Report is 10 commits behind head on main.

Files with missing lines Patch % Lines
src/scirpy/datasets/__init__.py 50.00% 2 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

@grst grst merged commit e02a82b into main Oct 22, 2024
9 checks passed
@grst grst deleted the stephenso2021_5k branch October 22, 2024 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants