https://github.com/nmfs-opensci/r-vscode-codespaces
Setups for R in Codespaces
https://github.com/nmfs-opensci/r-vscode-codespaces
codespaces
Last synced: 9 months ago
JSON representation
Setups for R in Codespaces
- Host: GitHub
- URL: https://github.com/nmfs-opensci/r-vscode-codespaces
- Owner: nmfs-opensci
- License: mit
- Created: 2022-11-23T15:25:13.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-22T15:24:12.000Z (over 1 year ago)
- Last Synced: 2025-02-15T22:43:56.184Z (11 months ago)
- Topics: codespaces
- Homepage:
- Size: 452 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# r-vscode-codespaces
Try running R code in a codespace where VScode is configured for use with R.
## Warning: this repo is no longer actively maintained!
These are example files for codespaces, but using R in Codespaces is always evolving, so files require active use ane maintenance.
Reach out to [@eeholmes](https://github.com/eeholmes) if you have questions.
## Maintained Codespace Templates and Container Images
- [The rocker project](https://rocker-project.org/images/devcontainer/templates.html#overview) provides templates and building blocks for R devcontainers.
- Michael Akridge's [Open Science Codespaces project](https://github.com/MichaelAkridge-NOAA/Open-Science-Codespaces) provides setups for R and R studio, Python, and more.
- [NMFS Open Science Container Images](https://github.com/nmfs-opensci/container-images). There are [instructions for using these with codespaces](https://github.com/nmfs-opensci/container-images?tab=readme-ov-file#with-codespaces).
## Maintained Codespace Files
These can be used to inspire your own Codespace files.
- [The FIMS codespace](https://github.com/NOAA-FIMS/FIMS/blob/main/.devcontainer/devcontainer.json). This is a codespace for R package development, including dependencies for building C++ code.
- [The FIMS case studies codespace](https://github.com/NOAA-FIMS/case-studies/blob/main/.devcontainer/devcontainer.json). This is a codespaces for using R packages and building a Quarto website.
- [The ghactions4r codespace](https://github.com/nmfs-fish-tools/ghactions4r/blob/main/.devcontainer/devcontainer.json). This is a codespace for R package development, with few package dependencies and no special tooling.
## How to use this repository with Codespaces
Two ways:
1. Click "Use this template" and "Open in a codespace" to directly use the repository in a codespace. This options works
if you don't plan on saving any files.
2. Click "Use this template" and "Create a new repository" to make your own repository based on r-vscode-codespaces. Then,
[open a codespace for the new repostory](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository).
There are several codespace options here:
- r-quarto (default): Use a codespace with basic R and quarto set up.
- r-base: Use a codespace with basic R set up.
See [creating a codespace in a repository](https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository) for instructions on how to select which codespace you would like to use. In short, the "New with Options" button should be selected to specify which codespace configuration to use.
## I already have an R project that I want to use with codespaces!!! What should I do?
Copy over the devcontainer.json of choice into a folder named `.devcontainer` within your R project's repository.