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

Modify existing and add new delta method transformations and begin work on documentation #2

Merged
merged 33 commits into from
Jul 30, 2024

Conversation

mbi6245
Copy link
Contributor

@mbi6245 mbi6245 commented May 23, 2024

  • reimplemented dictionary of transformations as class
  • implemented transform_percentage_change for strictly experimental data as described by Deng et al
  • implemented transform_percentage_change_counts for raw count data assuming no covariance
  • begin writing motivations for delta method, simple examples, and basic information about existing transformations in sphinx documentation

…lid due to use of switch statement in class constructor
…lid due to use of switch statement in class constructor
…ot have additional dependencies in test array
… 3.12 required in all relevant files, add flag to install packages without cache in build.yml
…t for count data, add crude testing for both functions, and updated sphinx documentation with basics for all pages except api reference and developer guide
def test_method_name_valid(transform):
"""Raise ValueError for invalue `method`."""
with pytest.raises(ValueError):
transform_data(VALS, VALS, transform, method='dummy')
transform_data(VALS, VALS, transform, method="dummy")
Copy link
Member

Choose a reason for hiding this comment

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

We recently started using pydantic for checking input. Not top priority, but if we used pydantic we could get rid of these sorts of tests!

@kels271828
Copy link
Member

Hi Max! Once we pull this branch into main, we can create smaller pull requests with branch names like feature/description, bugfix/description, docs/description, etc. That'll make each pull request more self-contained. I'll also delete my old develop branch.

@kels271828
Copy link
Member

Thinking ahead to when we might have lots of input types (e.g., single vector of mu/sigma vs. two vectors for proportions, etc.) and methods, do you think we should have just one function users interact with or multiple? Like would the percentage functions you added be called directly or get called from transform_data?

mbi6245 and others added 9 commits July 9, 2024 16:29
…n functions instead of hardcoding in aforementioned class, remove bias correction in experiment percentage change, clean up simulation .ipynb file
… documentation for univariate transformations
…orm_bivariate sphinx doc, and adjust testing accordingly to restructuring
@mbi6245 mbi6245 merged commit b9c7a3a into main Jul 30, 2024
1 check passed
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.

None yet

3 participants