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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
May 2, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ea43e9
Added case-sensitivity warning
mthomas-ketchbrook Apr 30, 2024
a5d2629
Moved anecdote & example to `r-apt` NOTES
mthomas-ketchbrook May 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/apt-packages/NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ The following example installs the `r-cran-curl` package after the `r-apt` Featu
"overrideFeatureInstallOrder": [
"ghcr.io/rocker-org/devcontainer-features/r-apt"
]
```
```
16 changes: 15 additions & 1 deletion src/r-apt/NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ apt-get -y install --no-install-recommends r-cran-dplyr
Thanks to [r2u](https://eddelbuettel.github.io/r2u/), on Ubuntu,
all packages on CRAN and BioConductor can be installed via apt.

If you want to install R packages via apt during the container build phase,
If you want to install R packages via apt during the container build phase (as opposed to installing R packages using the [`r-packages` Feature](https://github.com/rocker-org/devcontainer-features/tree/main/src/r-packages)),
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.

Expand All @@ -48,6 +48,20 @@ to do so.
`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).

When installing R packages via `r-cran-<package>` using the `apt-packages` Feature, R package name references must be lowercase. For example, the following snippet installs the {kableExtra} R package.

```json
"features": {
"ghcr.io/rocker-org/devcontainer-features/r-apt:latest": {},
"ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
"packages": "r-cran-kableextra"
}
},
"overrideFeatureInstallOrder": [
"ghcr.io/rocker-org/devcontainer-features/r-apt"
]
```

### Source installation via R

Packages that cannot be installed via apt must be installed using the R functions.
Expand Down