liftr/man/lift.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lift.R
\name{lift}
\alias{lift}
\title{Dockerize R Markdown Documents}
\usage{
lift(input = NULL, output_dir = NULL, dockerfile = NULL, ...)
}
\arguments{
\item{input}{Input (R Markdown or Shiny R markdown) file or shiny app folder.}

\item{output_dir}{Directory to output \code{Dockerfile}.
If not provided, will be the same directory as \code{input}.}

\item{dockerfile}{a Dockerfile path, if not, use our template.}

\item{...}{Extra arguments passed to liftShinyApp function.}
}
\value{
\code{Dockerfile} (and \code{Rabixfile} if possible).
}
\description{
Generate \code{Dockerfile} for R Markdown documents.
Rabix is supported if there is certain metadata in the R Markdown
document: the function will generate a \code{Rabixfile} containing
the parsed running parameters under the output directory.
}
\details{
After running \link{lift}, run \link{drender} on the document to
render the Dockerized R Markdown document using Docker containers.
See \code{vignette('liftr-intro')} for details about the extended
YAML front-matter metadata format used by liftr.
}
\examples{
# 1. Dockerized R Markdown document
dir_docker = paste0(tempdir(), '/lift_docker/')
dir.create(dir_docker)
file.copy(system.file("examples/docker.Rmd", package = "liftr"), dir_docker)
# use lift() to parse Rmd and generate Dockerfile
lift(paste0(dir_docker, "docker.Rmd"))
# view generated Dockerfile
readLines(paste0(dir_docker, "Dockerfile"))

# 2. Dockerized R Markdown document with Rabix options
dir_rabix = paste0(tempdir(), '/lift_rabix/')
dir.create(dir_rabix)
file.copy(system.file("template/rabix.Rmd", package = "liftr"), dir_rabix)
lift(input = paste0(dir_rabix, "rabix.Rmd"))
# view generated Dockerfile
readLines(paste0(dir_rabix, "Dockerfile"))
# view generated Rabixfile
readLines(paste0(dir_rabix, "Rabixfile"))
}