docs: Update README.md with comprehensive features and examples#8
Merged
john-aigora merged 1 commit intomasterfrom May 29, 2025
Merged
Conversation
The README.md has been significantly updated to reflect the current
capabilities of the sensPy library.
Key changes:
- Revised the introduction to state active development and broader feature set.
- Replaced the minimal 'Usage' section with an extensive 'Features' section.
- The 'Features' section now details:
- Core Psychometric Models: BetaBinomial, discrim, twoAC, dod, samediff.
- d-prime Hypothesis Testing: dprime_test, dprime_compare.
- ROC Utilities: SDT, AUC.
- Psychometric Link Functions: psyfun, psyinv, psyderiv, rescale.
- Power and Sample Size: power_discrim, sample_size_for_binomial_power.
- Each feature includes a brief description, its sensR equivalent, and a
concise, runnable Python code example.
- Ensured examples correctly import and use numpy where necessary.
- Retained existing 'Installation', 'Contributing', and 'License' sections.
This update provides a much clearer and more comprehensive overview for
you and potential contributors.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README.md has been significantly updated to reflect the current capabilities of the sensPy library.
Key changes:
This update provides a much clearer and more comprehensive overview for you and potential contributors.
Summary
Describe the changes in this pull request.
Testing
pytest