8000 Update vignettes by lauramaxwell · Pull Request #3 · Gilead-BioStats/gsm.core · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update vignettes #3

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

Merged
merged 7 commits into from
Mar 13, 2025
Merged

Update vignettes #3

merged 7 commits into from
Mar 13, 2025

Conversation

lauramaxwell
Copy link
Contributor
@lauramaxwell lauramaxwell commented Mar 11, 2025

Overview

Update vignettes. Mostly copied over edits from gsm PR #2042. Also updated the README and description

Note: The cookbook, contributor guidelines, Data Model and gsm Extensions will likely live in {openrbqm} and the openRBQM website, but I wanted them to have a home in the meantime so that people can still have all the documentation they need.

Test Notes/Sample Code

Connected Issues

Copy link
Contributor
@zdz2101 zdz2101 left a comment

Choose a reason for hiding this comment

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

Again mostly small stuff

- `Flag_Poisson()`: Default flagging function when `Analyze_Poisson()` is used for an assessment
- `Flag()`: Default flagging function when `Analyze_Identity()` is used for an assessment
- `Flag()`: Default flagging function for all assessments
- `Flag_NormalApprox()`: Deprecated flagging function when `Analyze_NormalApprox()` is used for an assessment.
Copy link
Contributor

Choose a reason for hiding this comment

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

Because gsm.core itself is starting out off the jump with just Flag() is it better to just remove any mentions of previously deprecated things?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hmmm, i suppose i wanted to keep this in there in case people were working with older workflows they have saved locally. might cut it once we get farther down the line.

@lauramaxwell lauramaxwell requested a review from zdz2101 March 13, 2025 16:31
Copy link
Contributor
@zdz2101 zdz2101 left a comment

Choose a reason for hiding this comment

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

LGTM

@lauramaxwell lauramaxwell merged commit bd6e68b into dev Mar 13, 2025
4 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.

QC: Update vignettes QC: Update ReadME
2 participants
0