357 stat methods vignette #365
Draft
Conversation
This file contains 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
|
Even just creating this PR I can see there's some grammar/spellings that need fixing - I'll do another pass to fix all that but please let me know if the content is what we're after @ddsjoberg @bzkrouse |
ddsjoberg
requested changes
Jan 8, 2025
| ) | ||
| ``` | ||
|
|
||
| The basic functions offered by {cards} can create a wide variety of ARDs. However, sometimes we may need to include the outputs from more complicated statistical methods in our ARDs. In this article we'll look at a few different ways to implement the output from these statistical methods. |
There was a problem hiding this comment.
Can we put each sentence on a new line? It makes it easier to track changes to the article in the future.
| dplyr::mutate(context = "t_test_one_sample") | ||
| ``` | ||
|
|
||
| Over 100 different statistical methods implemented in R are able to be 'tidied' using `broom::tidy`. However, the method you aim to use might not be, or the current `broom::tidy` implementation might not contain the information that you need to be in your ARD. In that case we'll have to format the output ourselves. |
There was a problem hiding this comment.
Should we make the distinction that only broom::tidy() methods that return a single row of results work here?
|
|
||
| As an example, let's write a function which carries out a Wilcoxon signed rank test over one variable using the function `wilcox.test`. As an output we just want to record the method and the p-value. | ||
|
|
||
| ```{r wilcox-function} |
There was a problem hiding this comment.
Would this be easier to read as wilcox_one_var <- \(x) wilcox.test(x)[c("method", "p.value")]
13 tasks
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.
What changes are proposed in this pull request?
#357 Add an article detailing how a user can implement their own statistical methods
I'll open this as a draft for now as it would be good just to get a review on the content initially if you have time @ddsjoberg?
Also a couple of points/questions:
{cardx}example, which would mean adding{cardx}to Suggests. I'm happy to remove, just couldn't remember exactly what we agreed on in the last meeting.as_cards_fnbeing new and installation restrictions on our SCE - if this is important then I should be able to work around it to render the articlecloses #357
Pre-review Checklist (if item does not apply, mark is as complete)
usethis::pr_merge_main()devtools::test_coverage()Reviewer Checklist (if item does not apply, mark is as complete)
pkgdown::build_site(). Check the R console for errors, and review the rendered website.devtools::test_coverage()When the branch is ready to be merged:
NEWS.mdwith the changes from this pull request under the heading "# cards (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (seeNEWS.mdfor examples).