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.

Sign up for GitHub

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

Jump to bottom

Add sensitivity functions to produce vector of new pars that vary sd without changing mean #58

Merged
merged 32 commits into from
May 16, 2024
Merged

Add sensitivity functions to produce vector of new pars that vary sd without changing mean #58

merged 32 commits into from
May 16, 2024

Conversation

nehill197
Copy link
Member

@nehill197 nehill197 commented May 15, 2024 •
edited
Loading

References issue #59

nehill197 added 25 commits May 14, 2024 14:22
@nehill197
Add functions to calculate new parameters of various distributions, w…
6351c55 
…ith the general goal of adjusting the standard deviation by a multiplier, without changing the mean.
@nehill197
Add sd_mult parameter
647ea9d
@nehill197
Add examples, adjust titles
1384d3c
@nehill197
Add return value descriptions
3da2937
@nehill197
Correct returned parameter
857b582
@nehill197
Make error wording the same
73d8b24
@nehill197
Rate can be 0
e1a8243
@nehill197
Fix wording, add checks, add gamma distribution sensitivity function
e72aff4
@nehill197
Preliminary tests for sensitivity functions
1c407d9
@nehill197
return vector
3d8c154
@nehill197
Add tests for NULL inputs, empty numeric vector inputs, and numeric v…
bb6e0cd 
…ector (> length 1) inputs for all arguments for all functions
@nehill197
styler (alphabetized)
4955391
@nehill197
Documentation for new sensitivity functions
7948c95
@nehill197
Docs for new sens functions
08f95cf
@nehill197
Styler
8b77fab
@nehill197
Update RoxygenNote and add withr to suggests
0d1c04a
@nehill197
Add family and inherit params
464bd67
@nehill197
Lint fixes
9119e6b
@nehill197
Add alpha and beta parameter documentation
fcd8fe5
@nehill197
Add detailed function descriptions and remove comments
0aff54d
@nehill197
Add sensitivity functions to yml
c47917f
@nehill197
Update R-CMD-check to "check-standard"
ca936db
@nehill197
Now requires R >= 4.3.3
fd5daa2
@nehill197
Remove sens_pois_zi (sd changes differently for diff. values of prob).
da1e9c9
@nehill197
Change to R 4.3.0
fe00d18
@nehill197
Copy link
Member Author

extras is dependent on the sn package, which in turn is dependent on the Matrix package, which now requires R >= 4.4.0 (though the actions passed on R 4.3.0). I changed the R dependency to 4.3.0, and updated the R-CMD-check actions from the "overkill" set that included the windows on R 4.1 and the older ubuntu versions to the "check standard" version.

@nehill197
Copy link
Member Author

nehill197 commented May 16, 2024 •
edited
Loading

The binomial family of distributions don't seem to have a clear solution to adjust the parameters to expand the sd without changing the mean.
I also haven't included a function for the zero-inflated Poisson distribution because it's proving difficult.

@nehill197
Copy link
Member Author

This pull request also includes a handful of styler and lintr suggestions to some of the other functions/tests/vignettes.

@nehill197 nehill197 requested a review from joethorley May 16, 2024 14:55
joethorley
joethorley approved these changes May 16, 2024
View reviewed changes
Copy link
Member

@joethorley joethorley left a comment

Choose a reason for hiding this comment

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

looks great!

R/sens.R Outdated
#'
#' @inheritParams params
#'
#' @return A named vector of the adjusted distribution's parameters.
Copy link
Member

Choose a reason for hiding this comment

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

The return object description will need changing to A named list of the...

@nehill197 nehill197 merged commit 7b5154a into main May 16, 2024
7 checks passed
@nehill197 nehill197 deleted the sensitivity branch May 16, 2024 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joethorley joethorley joethorley approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nehill197 @joethorley