Allowing use of magrittr pipe in `survfit2()`

ddsjoberg commented 1 year ago

What changes are proposed in this pull request?

Updating the saved environment in survfit2() to include the magrittr . when it is present.

If there is an GitHub issue associated with this pull request, please provide link. closes #93

Reviewer Checklist (if item does not apply, mark is as complete)

[x] Ensure all package dependencies are installed by running renv::install()
[x] PR branch has pulled the most recent updates from master branch. Ensure the pull request branch and your local version match and both have the latest updates from the master branch.
[x] If a new function was added, function included in _pkgdown.yml
[x] If a bug was fixed, a unit test was added for the bug check
[x] Run pkgdown::build_site(). Check the R console for errors, and review the rendered website.
[x] Overall code coverage remains >99.5%. Review coverage with withr::with_envvar(new = c("NOT_CRAN" = "true"), covr::report()). Begin in a fresh R session without any packages loaded.
[x] R CMD Check runs without errors, warnings, and notes
[x] usethis::use_spell_check() runs with no spelling errors in documentation

When the branch is ready to be merged into master:

[ ] Update NEWS.md with the changes from this pull request under the heading "# ggsurvfit (development version)". If there is an issue associated with the pull request, reference it in parentheses at the end update (see NEWS.md for examples).
[ ] Increment the version number using usethis::use_version(which = "dev")
[ ] Run codemetar::write_codemeta()
[ ] Run usethis::use_spell_check() again
[ ] Approve Pull Request
[ ] Merge the PR. Please use "Squash and merge".

shannonpileggi commented 1 year ago

the only thing i could find is that

library(ggsurvfit)
#> Loading required package: ggplot2

df_colon %>% 
  survfit2(Surv(.$time, .$status) ~ surg, data = .) %>% 
  ggsurvfit(size = 1)

^{Created on 2022-10-03 by the reprex package (v2.0.1)}

results in the time variable label not being passed through

ddsjoberg commented 1 year ago

Thanks for taking a look @shannonpileggi !!

ddsjoberg commented 1 year ago

I feel it would be worth adding an example and text in the survfit2 docstring to explain the current behaviour with pipes i.e. on line 64 add something like
df_lung %>% survfit2(Surv(time, status) ~ sex, data  = .) %>%
  summary(times = c(10, 20))

Thanks @bailliem ! I think because we're accounting for a non-standard use of the magrittr pipe (typically it's passed to the first argument), we don't need an example highlighting how to use it this way. Also, Hadley is prepping the purrr v1.0 release, and he's removed all %>% and replaced them with |>.

ddsjoberg commented 1 year ago

@SHAESEN2 let's address and PARAM changes in a separate PR

pharmaverse / ggsurvfit

Allowing use of magrittr pipe in `survfit2()` #99