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

Rename KS Rank to RSA and fix documentation #172

Merged
merged 19 commits into from
Jul 25, 2024
Merged

Rename KS Rank to RSA and fix documentation #172

merged 19 commits into from
Jul 25, 2024

Conversation

max-de-rooij
Copy link
Contributor

@max-de-rooij max-de-rooij commented Jul 22, 2024

Checklist

  • Appropriate tests were added
  • Any code changes were done in a way that does not break public API
  • All documentation related to code changes were updated
  • The new code follows the
    contributor guidelines, in particular the SciML Style Guide and
    COLPRAC.
  • Any new documentation only uses public API

Additional context

The method I previously defined as KSRank in #170, is apparently known in the literature as RSA (Regional Sensitivity Analysis). Therefore, I renamed the method and added the necessary documentation.

max-de-rooij and others added 19 commits July 15, 2024 12:33
add raw string annotation
KSRank is stochastic and slight variations in the outcome measures are possible. New tests check whether parameters are correctly identified as sensitive.
Make tests less sensitive to random variability in the sensitivity criterion. Also indicate the random variability influence in the documentation.
Use JuliaFormatter
Add more detailed explanation of f(Y) function signature, and fix typos in math.
Add description of returned KSRankResult struct
Change math $ into ``
Renamed KS_Rank to RSA in line with how the method is known in literature.
fix compatibility issues with SortingAlgorithms.jl
Bump lower bound of StatsBase to 0.33.7
Modify default argument of n_dummy_parameters to 10
@max-de-rooij
Copy link
Contributor Author

This should also fix #13

@max-de-rooij
Copy link
Contributor Author

And fixes the downgrade test fail by bumping StatsBase lower bounds to 0.33.7

@Vaibhavdixit02 Vaibhavdixit02 merged commit 978b1d2 into SciML:master Jul 25, 2024
10 checks 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.

2 participants