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

Update vignettes #334

Open
3 of 8 tasks
kellijohnson-NOAA opened this issue Oct 18, 2021 · 1 comment
Open
3 of 8 tasks

Update vignettes #334

kellijohnson-NOAA opened this issue Oct 18, 2021 · 1 comment
Assignees
Labels
status --- wip work in progress topic --- vignette information within a vignette or ideas for vignettes topic --- website website generated with {pkgdown}

Comments

@kellijohnson-NOAA
Copy link
Contributor

kellijohnson-NOAA commented Oct 18, 2021

Problem

The vignettes hadn't been looked at in a while and a large number of issues with the vignette label were accumulating. Also, pkgdown is pretty great and will add to the user experience.

Proposal

Disclaimers

  • there is the potential for not all of the issues to be closed in the vignette branch, which is okay, just remove the working on label and save them for a later date
@kellijohnson-NOAA kellijohnson-NOAA added topic --- vignette information within a vignette or ideas for vignettes type --- documentation requires changes to the docs topic --- website website generated with {pkgdown} status --- wip work in progress and removed type --- documentation requires changes to the docs labels Oct 18, 2021
@k-doering-NOAA
Copy link
Contributor

It would be nice to include in the vignette an example of specifying om and em directories within the sim df; For example, https://github.com/k-doering-NOAA/cal-sims/blob/ce4ada6df484e8b941d81227e7e4419f051569ad/code/piner_et_al_scenarios.R#L89-L90

However, it would be even more helpful to show different om/em paths per scenario

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status --- wip work in progress topic --- vignette information within a vignette or ideas for vignettes topic --- website website generated with {pkgdown}
Projects
None yet
Development

No branches or pull requests

2 participants