1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/jobs.R
\name{jobRunScript}
\alias{jobRunScript}
\title{Run R Script As Background Job}
\usage{
jobRunScript(
path,
name = NULL,
encoding = "unknown",
workingDir = NULL,
importEnv = FALSE,
exportEnv = ""
)
}
\arguments{
\item{path}{The path to the R script to be run.}
\item{name}{A name for the background job. When \code{NULL} (the default),
the filename of the script is used as the job name.}
\item{encoding}{The text encoding of the script, if known.}
\item{workingDir}{The working directory in which to run the job. When
\code{NULL} (the default), the parent directory of the R script is used.}
\item{importEnv}{Whether to import the global environment into the job.}
\item{exportEnv}{The name of the environment in which to export the R
objects created by the job. Use \code{""} (the default) to skip export,
\code{"R_GlobalEnv"}` to export to the global environment, or the name of an
environment object to create an object with that name.}
}
\description{
Starts an R script as a background job.
}
\seealso{
Other jobs:
\code{\link{jobAdd}()},
\code{\link{jobAddOutput}()},
\code{\link{jobAddProgress}()},
\code{\link{jobGetState}()},
\code{\link{jobList}()},
\code{\link{jobRemove}()},
\code{\link{jobSetProgress}()},
\code{\link{jobSetState}()},
\code{\link{jobSetStatus}()}
}
\concept{jobs}
|