README.md

In rytenlab/rockup: What the Package Does (One Line, Title Case)

rockup

The goal of rockup is to make it easy to connect to R Studio Server via rocker.

Installation instructions

Install the development version of rockup from GitHub with:

BiocManager::install("rytenlab/rockup")

Basic usage

rockup has a single user-level function docker_run_rserver, which is designed to start a container running R Studio Server on a rocker. Below is an example of how to run docker_run_rserver with minimal config, for a more detailed guide see the vignette.

docker_run_rserver(
  image = "bioconductor/bioconductor_docker:RELEASE_3_13",
  port = 8888,
  name = "your_container_name"
)

Code of Conduct

Please note that the rockup project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Development tools

• Continuous code testing is possible thanks to GitHub actions through usethis, remotes, and rcmdcheck customized to use Bioconductor’s docker containers and BiocCheck.
• Code coverage assessment is possible thanks to codecov and covr.
• The documentation website is automatically updated thanks to pkgdown.
• The code is styled automatically thanks to styler.
• The documentation is formatted thanks to devtools and roxygen2.

For more details, check the dev directory.

This package was developed using biocthis.

rytenlab/rockup documentation built on Dec. 22, 2021, 8:19 p.m.