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

Add a vignette / article on working with CHI numbers #106

Merged
merged 6 commits into from
Nov 27, 2023

Conversation

Moohan
Copy link
Member

@Moohan Moohan commented Sep 13, 2023

Inspired by the question on Teams this morning. I wrote an article / vignette to which goes hopefully explains, with examples, all the functions which do things with CHI numbers.

The nicest way to view this is as an article with pkgdown, where you can see it as it will look on the online documentation.

pkgdown::init_site()
pkgdown::build_article("chi-operations")
pkgdown::preview_page('articles/chi-operations.html')

Alternatively/additionally to see it as a vignette in R:

devtools::build_vignettes()
devtools::load_all()
vignette("chi-operations", package = "phsmethods")

@Tina815 This can wait for a future version if you want s I know you're very close to finalising 0.2.3!

@Moohan Moohan added the documentation Improvements or additions to documentation label Sep 13, 2023
@Moohan Moohan requested a review from Tina815 September 13, 2023 16:45
Base automatically changed from development to master September 15, 2023 13:17
@Moohan Moohan changed the base branch from master to dev November 21, 2023 16:38
Copy link

codecov bot commented Nov 21, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (106aaa6) 97.40% compared to head (0c4eb4f) 97.40%.
Report is 3 commits behind head on dev.

Additional details and impacted files
@@           Coverage Diff           @@
##              dev     #106   +/-   ##
=======================================
  Coverage   97.40%   97.40%           
=======================================
  Files          13       13           
  Lines         424      424           
=======================================
  Hits          413      413           
  Misses         11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Tina815 Tina815 merged commit b12278c into dev Nov 27, 2023
17 checks passed
@Tina815 Tina815 deleted the vignettes/chi-operations branch November 27, 2023 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants