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

feat: add text stimulus class #676

Merged
merged 17 commits into from
Mar 15, 2024
Merged

feat: add text stimulus class #676

merged 17 commits into from
Mar 15, 2024

Conversation

SiQube
Copy link
Member

@SiQube SiQube commented Feb 9, 2024

No description provided.

Copy link

codecov bot commented Feb 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (dc90857) to head (05acea0).

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #676   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           55        57    +2     
  Lines         2530      2559   +29     
  Branches       644       647    +3     
=========================================
+ Hits          2530      2559   +29     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dkrako dkrako linked an issue Feb 9, 2024 that may be closed by this pull request
Copy link
Contributor

@dkrako dkrako left a comment

Choose a reason for hiding this comment

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

Thank you so much for working on this task! I think the current startout supposes too big of a scope of this PR. We should keep the scope very limited and work iteratively on adding new functionalities in distinct PRs. The TextStimulus class will be experimental for a while, but I think this strategy is better than having too big of a scope in this big project.

This PR should focus on the basics first and only, returning a TextStimulus class which has an aoi attribute when calling pymovements.stimulus.text.from_file().

@dkrako
Copy link
Contributor

dkrako commented Feb 9, 2024

We'll discuss next friday if it should be pymovements.stimulus or pymovements.stimuli.

The class TextStimulus should be available via pymovements.TextStimulus anyway.

Copy link
Contributor

@dkrako dkrako left a comment

Choose a reason for hiding this comment

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

Thanks a lot, that's a good direction the PR is taking!
There is some more work needed around the edges but we're getting to it soon!

@dkrako dkrako added the enhancement New feature or request label Feb 22, 2024
@SiQube SiQube marked this pull request as ready for review February 23, 2024 12:32
@SiQube SiQube requested a review from prassepaul as a code owner February 23, 2024 12:32
@dkrako dkrako changed the title WIP stimulus class feat: add text stimulus class Feb 29, 2024
Copy link
Contributor

@dkrako dkrako left a comment

Choose a reason for hiding this comment

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

Great! Just two minor things and then there's the question about if we should clone a input dataframe.

On a more general note, I would like to discuss tomorrow if we want the naming to be

  1. Stimulus.aois
  2. or Stimulus.areas

I orignally proposed aois, but somehow I think areas would be a better fit.

Copy link
Contributor

@dkrako dkrako left a comment

Choose a reason for hiding this comment

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

Excellent! There are some tiny bits in the __init__.py and the docstrings need parameter specifications but that's about it.

Copy link
Contributor

@dkrako dkrako left a comment

Choose a reason for hiding this comment

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

Excellent! Thank you so much for this work!

@dkrako dkrako merged commit e1ba1ff into main Mar 15, 2024
21 checks passed
@dkrako dkrako deleted the stimulus-class branch March 15, 2024 09:59
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.

integrate text stimulus into GazeDataFrame
2 participants