Skip to content

Document dependency setup paths with and without renv - #110

Merged
iantaylor-NOAA merged 4 commits into
mainfrom
copilot/remove-package-installation-setup-qmd
Jul 10, 2026
Merged

Document dependency setup paths with and without renv#110
iantaylor-NOAA merged 4 commits into
mainfrom
copilot/remove-package-installation-setup-qmd

Conversation

Copilot AI commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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 both renv and non-renv workflows.

  • Dependency setup guidance

    • Added a new R package dependencies section in README.md.
    • Documents renv workflow when a lockfile is present.
    • Documents non-renv workflow by pointing to the maintained dependency sources:
      • .github/workflows/render.yml
      • .github/workflows/render-and-publish.yml
      • .devcontainer/devcontainer.json
  • Scope

    • README-only update; no codepath or workflow logic changes.
install.packages("renv")
renv::restore()

Copilot AI linked an issue Jul 9, 2026 that may be closed by this pull request
3 tasks
Copilot AI changed the title [WIP] Update README with package installation instructions Document dependency setup paths with and without renv Jul 9, 2026
Copilot AI requested a review from iantaylor-NOAA July 9, 2026 21:52

@iantaylor-NOAA iantaylor-NOAA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.

Copilot AI commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

@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 cas...

Addressed in commit 3bb6e65.

README now includes a non-renv install snippet that reads package dependencies directly from .github/workflows/render.yml and installs them via pak::pak(deps), so users don’t need to manually copy package names. I also added a concrete single-source direction: move to one canonical dependency file (e.g., config/r-packages.txt) that workflows, devcontainer setup, and local install docs can all consume.

@iantaylor-NOAA iantaylor-NOAA left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot, this is helpful and the R script added to README worked well for me. Please make the one additional changes as suggested.

Comment thread README.md Outdated
- 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.

@iantaylor-NOAA iantaylor-NOAA Jul 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this line since it's been moved into a separate issue: #111

Copilot AI commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

@copilot, this is helpful and the R script added to README worked well for me. Please make the one additional changes as suggested.

Done in commit e01a627.

Copilot AI requested a review from iantaylor-NOAA July 9, 2026 23:53
@iantaylor-NOAA
iantaylor-NOAA marked this pull request as ready for review July 9, 2026 23:56
@MOshima-PIFSC

Copy link
Copy Markdown
Contributor

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. purrr, stringr, etc) which would create more steps so I think using base functions is best.
The changes look good and I think its good to merge.

@kellijohnson-NOAA
kellijohnson-NOAA force-pushed the copilot/remove-package-installation-setup-qmd branch from e01a627 to 25725ff Compare July 10, 2026 17:13
@iantaylor-NOAA
iantaylor-NOAA merged commit aba379f into main Jul 10, 2026
1 check failed
@iantaylor-NOAA
iantaylor-NOAA deleted the copilot/remove-package-installation-setup-qmd branch July 10, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Developer Issue]: Remove package installation from setup.qmd

3 participants