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

docs(r-apt): Added case-sensitivity of apt packages warning #219

Merged
merged 2 commits into from
May 2, 2024

Conversation

mthomas-ketchbrook
Copy link
Contributor

Considering R users who may used to installing R packages via install.packages(...) (where package names may be a mix of upper- and lower-case letters) from an R session, I believe it may be useful to document that installing R packages via apt-packages requires that the package name be lowercase within r-cran-<package>.

Copy link
Member

@eitsupi eitsupi left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution!

However, I think it is too topical to mention r-cran-* here (i.e., I believe that this Feature is used more often for purposes other than R package installation).
How about adding to the following section?

If you want to install R packages via apt during the container build phase,
you can use [the `ghcr.io/rocker-org/devcontainer-features/apt-packages` Feature](https://github.com/rocker-org/devcontainer-features/blob/main/src/apt-packages)
to do so.
```json
"features": {
"ghcr.io/rocker-org/devcontainer-features/r-apt:latest": {},
"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
"packages": "r-cran-curl"
}
},
"overrideFeatureInstallOrder": [
"ghcr.io/rocker-org/devcontainer-features/r-apt"
]
```
`ghcr.io/rocker-org/devcontainer-features/apt-packages` is not guaranteed to install after this Feature,
so be sure to set up [the `overrideFeatureInstallOrder` property](https://containers.dev/implementors/features/#overrideFeatureInstallOrder).

And, it seems that uppercase letters cannot be used in apt package names in the first place.
https://askubuntu.com/questions/1262528/what-are-usable-characters-are-for-package-names

@mthomas-ketchbrook
Copy link
Contributor Author

Thank you so much for your kind response!

Embarassingly, I had overlooked the r-packages feature when I originally created this PR. The r-packages feature seems to be the most "appropriate" place to install R packages.

I'd be happy to add to the section you referenced, and perhaps add an additional comment to simply point out that the r-packages feature also exists for the purposes of installing R packages.

Would you prefer that I make these changes to the NOTES.md file or the README.md?

@eitsupi
Copy link
Member

eitsupi commented May 1, 2024

Thanks for checking this out.

Yes, you are correct, the README is automatically generated from the NOTES, so we need to edit the NOTES.

@mthomas-ketchbrook
Copy link
Contributor Author

I moved the anecdote & example from the apt-packages Feature NOTES to the r-apt Feature NOTES in a5d2629.

Please let me know if this is what you had in mind, or if there are any additional changes I should make. Thanks!

@eitsupi eitsupi changed the title Added case-sensitivity warning docs(r-apt): Added case-sensitivity of apt packages warning May 2, 2024
Copy link
Member

@eitsupi eitsupi left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@eitsupi eitsupi merged commit 6242fb9 into rocker-org:main May 2, 2024
1 check passed
@eitsupi
Copy link
Member

eitsupi commented May 2, 2024

The README has been updated by b24eea2.

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.

2 participants