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

Standardize documentation in package.R #104

Merged
merged 7 commits into from Sep 6, 2023
Merged

Standardize documentation in package.R #104

merged 7 commits into from Sep 6, 2023

Conversation

nanxstats
Copy link
Collaborator

This PR fixes #103.

  • Use usethis::use_package_doc() to generate standard package doc page.
  • Move some content of the textual blocks in R/package.R to two new vignettes.
  • Let the exported functions spendingFunction() and summary.spendfn() have their own proper Rd documentation page and improve documentation style following the tidyverse style guide.
  • Link the vignette(s) in the pkgdown function reference page section description like in extending ggplot2.
  • Update all Rd @seealso links pointing to the original Rd pages to pointing to the new vignettes.

@nanxstats nanxstats changed the title Standardize documentation Standardize documentation in package.R Sep 6, 2023
@keaven
Copy link
Owner

keaven commented Sep 6, 2023

Possibly add gsBoundSummary(x) in gsDesignPackageOverview.Rmd

@keaven keaven closed this Sep 6, 2023
@keaven keaven reopened this Sep 6, 2023
@nanxstats nanxstats marked this pull request as ready for review September 6, 2023 15:55
@keaven keaven merged commit d7f6b28 into master Sep 6, 2023
9 checks passed
@keaven keaven deleted the issue-103 branch September 6, 2023 18:32
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.

Standardize documentation in package.R
2 participants