Reorder doc pages so analyze functions appear first, add links in README #1131
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
|
Code Coverage SummaryDiff against mainResults for commit: 71b5911 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
Melkiades
reviewed
Nov 13, 2023
Melkiades
reviewed
Nov 13, 2023
pawelru
reviewed
Nov 13, 2023
Melkiades
reviewed
Nov 16, 2023
Comment on lines
+44
to
+46
| - See a list of all available analyze functions [here](https://insightsengineering.github.io/tern/reference/analyze_functions.html) | ||
| - See a list of all available summarize functions [here](https://insightsengineering.github.io/tern/reference/summarize_functions.html) | ||
| - See a list of all available column-wise analysis functions [here](https://insightsengineering.github.io/tern/reference/analyze_colvars_functions.html) |
There was a problem hiding this comment.
Thanks for this. It was really needed!
Melkiades
reviewed
Nov 16, 2023
Comment on lines
-32
to
-46
| #' df <- extract_survival_biomarkers( | ||
| #' variables = list( | ||
| #' tte = "AVAL", | ||
| #' is_event = "is_event", | ||
| #' biomarkers = c("BMRKR1", "AGE"), | ||
| #' strata = "STRATA1", | ||
| #' covariates = "SEX", | ||
| #' subgroups = "BMRKR2" | ||
| #' ), | ||
| #' data = adtte_f | ||
| #' ) | ||
| #' df | ||
| #' | ||
| #' @name survival_biomarkers_subgroups | ||
| NULL |
There was a problem hiding this comment.
the examples were repeated right?
Melkiades
reviewed
Nov 16, 2023
Comment on lines
-81
to
-90
| #' @examples | ||
| #' library(dplyr) | ||
| #' library(forcats) | ||
| #' | ||
| #' adtte <- tern_ex_adtte | ||
| #' adtte_labels <- formatters::var_labels(adtte) | ||
| #' | ||
| #' adtte_f <- adtte %>% | ||
| #' filter( | ||
| #' PARAMCD == "OS", |
There was a problem hiding this comment.
this pre-proc was too repeated right?
There was a problem hiding this comment.
Yes - I didn’t outright remove any examples or pre-processing unless it was duplicated on the page
Melkiades
approved these changes
Nov 16, 2023
There was a problem hiding this comment.
Amazing job Emily!! Thanks so much for polishing and consolidating examples too. I think it will feel much fresher now. Also having the main {rtables}/user-facing function top is much better now. Do you think we should also add a seealso for the lists of analysis functions?
Good to go anyway ;)
I don't think it's necessary to link to all the other analyze functions since most of them are not closely related - any that are can be linked via |
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.
Pull Request
Part of #1130
I'm separating this issue into multiple PRs so nothing gets mixed up.