Improve documentation #181
Merged
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
* Add self-contained, executable example usage in readme * Addresses #174
* Simplify/revise description of simChef concepts and parts of experiment * Add run experiment figure * Add concrete examples of DGP/methods/evals/viz using example usage * Addresses #174
* add link to real world case study in readme * add links to example html outputs for toy sims from simChef vignettes * addresses #174
* address #174
* add examples (#174) * create wrappers for DGP$generate, Method$fit, Evaluator$evaluate, and Visualizer$visualize methods * fix bug in add_na_counts
* move text to collapsible blocks * bold simChef highlights in "thinking like a chef" to address #174
This was referenced Feb 6, 2024
jpdunc23
reviewed
Feb 6, 2024
Co-authored-by: James Duncan <jpdunc23@users.noreply.github.com>
|
@tiffanymtang when you can, please review the updates I've made. In particular, could you spot check the docs for the Still need to document |
* improve visualizer example usage * change T to TRUE in example usage to avoid R CMD CHECK error * change varying parameter to varying parameter(s)
Use of `future::plan("multisession", workers=10)` in the Evaluator and
Visualizer docs examples is likely causing issues in the check-r-package
job.
|
Hey @tiffanymtang , could you please do another spot check of the latest changes? Unless you see any issues I think we can merge this in soon. |
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.
This pull request addresses #174. Overview of changes:
Added runnable example usage in readme.
Added diagram of
run_experiment()to the "Grammar of a simChef Simulation Experiment" section to aid understanding.Restructured "Origins of simChef" section to de-emphasize this content, as it is not critical to understanding how to use
simChef. Also added bolding to the "Thinking like a chef" subsection to highlightsimCheffunctionalities that was previously tangled in cooking analogy.Added reference to real world use case of
simChefin Boileau et al. at the end of the toy example usage.Finished adding examples to all
simCheffunctions.Added contributing guidelines in CONTRIBUTING.md.