session_info_converter: Title

Description Usage Arguments Examples

View source: R/session_info_converter.R

Description

Title

Usage

1
2
3
4
5
6
7
session_info_converter(
  write_file = T,
  org = "rocker",
  image = "r-base:latest",
  dir = "./",
  filename = "Dockerfile"
)

Arguments

write_file

Defaults to true,and writes a Dockerfile at the path (and filename) you choose. If you instead select 'F', the output will be written to the console (or whatever connection you currently have open). Writing a file will overwrite any Dockerfile in the same location. 'T' is probably appropriate for exporting to a tool like mybinder.org, 'F' is appropriate if you already have a Dockerfile and you just want to cut and paste sections from this function into it.

org

Defaults to Rocker (https://www.rocker-project.org/), but you can choose whichever group you like; the Dockerfile will probably only work as the basis for a Docker container if the underlying image comes with r. You can leave this parameter blank if, for instance, you want to access Docker's official R images, available here: https://hub.docker.com/_/r-base

image

Defaults to r-base:latest, whose source code is on Rocker's GitHub: currently, https://github.com/rocker-org/rocker/blob/master/r-base/latest/Dockerfile. available tags r-base are listed here: https://hub.docker.com/r/rocker/r-base/tags, and help with installing previous versions of R. Other Rocker images can be browsed here: https://hub.docker.com/u/rocker

dir

Defaults to current directory, './'.

filename

Defaults to 'Dockerfile', making the composite file './Dockerfile'.

Examples

1
2
session_info_converter()
session_info_converter(write_file = F, image = 'geospatial')

setgree/ResultsStandardizeR documentation built on June 2, 2020, 11:48 a.m.