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

Added smillie_2019 dataloader and renamed smillie dataset to tasccoda_example #450

Merged
merged 4 commits into from
Nov 30, 2023

Conversation

Lilly-May
Copy link
Collaborator

PR Checklist

  • Referenced issue is linked (contributes to Consistent API experience #405)
  • Tests adapted to changes
  • Documentation in docs is updated (description of datasets)

Description of changes

  • Added the smillie_2019() dataset, which is now accessible via the dataloader. Initially, we observed that the tascCODA tutorial reads a local file instead of one from the pertpy dataloader, making it challenging for users to reproduce the tutorial. Hence, we decided to include the dataset containing both count data and detailed annotation required for processing with tascCODA.

  • To avoid confusion, I renamed the previously labeled smillie() dataset to tasccoda_example(). The dataset doesn't actually contain smillie's count data, only the mudata['coda'] part. Since it's still a useful dataset for testing tascCODA due to its smaller size, we chose to keep it but under a different name. I also updated all occurrences (in one tasccoda test and several docs examples) of pt.dt.smillie() to pt.dt.tasccoda_example().

Technical details

The smillie_2019() dataset was created using this notebook.

@github-actions github-actions bot added the enhancement New feature or request label Nov 30, 2023
Copy link
Member

@Zethson Zethson left a comment

Choose a reason for hiding this comment

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

Great! Thank you very much!

pertpy/data/_datasets.py Show resolved Hide resolved
Copy link

codecov bot commented Nov 30, 2023

Codecov Report

Merging #450 (df9fdcd) into main (91bce09) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #450   +/-   ##
=======================================
  Coverage   57.83%   57.83%           
=======================================
  Files          40       40           
  Lines        4933     4933           
=======================================
  Hits         2853     2853           
  Misses       2080     2080           
Files Coverage Δ
pertpy/data/__init__.py 100.00% <ø> (ø)
pertpy/data/_datasets.py 100.00% <ø> (ø)
pertpy/plot/_coda.py 7.00% <ø> (ø)
pertpy/tools/_coda/_base_coda.py 55.79% <ø> (ø)
pertpy/tools/_coda/_tasccoda.py 77.48% <ø> (ø)

@Lilly-May Lilly-May merged commit 1e4e33b into main Nov 30, 2023
8 checks passed
@Lilly-May Lilly-May deleted the feature/smillie_dataloader branch December 13, 2023 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants