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

create_sim: improvements to docs and vignettes #176

Open
4 tasks
jpdunc23 opened this issue Jan 15, 2024 · 0 comments
Open
4 tasks

create_sim: improvements to docs and vignettes #176

jpdunc23 opened this issue Jan 15, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jpdunc23
Copy link
Contributor

jpdunc23 commented Jan 15, 2024

Motivated by #175, the documentation and vignette for create_sim could be improved. Here are some specific items:

  • Change "character" to "string" in the description of the path arg.
  • Change "high-power computing" to "high-performance computing" throughout.
  • Add examples with file trees for various combinations of the args. Could some or all of the vignette be incorporated into the docs?
  • Incorporate create_sim() in the Getting started with simChef vignette.

More generally, we should emphasize create_sim() as an optional first step to setting up a new simulation project and clarify our basic integration with renv and git.

See #177 as well.

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

No branches or pull requests

2 participants