Document dependency setup paths with and without renv - #110
Conversation
renv
iantaylor-NOAA
left a comment
There was a problem hiding this comment.
@copilot, the changes are better than nothing, but I was imagining a more user-friendly approach that doesn't require manually copying and pasting the package names (and their github repos in some cases) into pak::pak(), like the loop previously used in setup.qmd:
https://github.com/NOAA-FIMS/case-studies/blob/4864870f4d9a962a7cb4ffe5737e95e282db38f1/content/setup.qmd
However, it would be nice to have a single list of package dependencies used throughout rather than trying to keep in sync the different yml files and the README. Any big-picture ideas along these lines would be helpful.
Addressed in commit README now includes a non- |
iantaylor-NOAA
left a comment
There was a problem hiding this comment.
@copilot, this is helpful and the R script added to README worked well for me. Please make the one additional changes as suggested.
| - Dependency sources currently used in this repo: | ||
| - CI renders: `.github/workflows/render.yml` and `.github/workflows/render-and-publish.yml` | ||
| - Codespaces: `.devcontainer/devcontainer.json` | ||
| - Big-picture idea for future cleanup: keep one canonical dependency list (for example `config/r-packages.txt`) and have workflows, devcontainer setup, and local install instructions all read from that single file. |
There was a problem hiding this comment.
Delete this line since it's been moved into a separate issue: #111
Done in commit |
|
I tested the non-renv steps and it works. I thought about switching the code to tidy-style to match with the rest of the FIMS code base but then realized the user may have to install some packages first to do that (e.g. |
e01a627 to
25725ff
Compare
This issue asked for README guidance on package installation now that setup code was removed from
setup.qmd. This update adds explicit dependency setup instructions for bothrenvand non-renvworkflows.Dependency setup guidance
README.md.renvworkflow when a lockfile is present.renvworkflow by pointing to the maintained dependency sources:.github/workflows/render.yml.github/workflows/render-and-publish.yml.devcontainer/devcontainer.jsonScope