File: jobRunScript.Rd

package info (click to toggle)
r-cran-rstudioapi 0.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 592 kB
  • sloc: makefile: 2
file content (33 lines) | stat: -rw-r--r-- 1,170 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/jobs.R
\name{jobRunScript}
\alias{jobRunScript}
\title{Run R Script As Job}
\usage{
jobRunScript(path, encoding = "unknown", workingDir = NULL,
  importEnv = FALSE, exportEnv = "")
}
\arguments{
\item{path}{The path to the R script to be run.}

\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{jobAddOutput}},
  \code{\link{jobAddProgress}}, \code{\link{jobAdd}},
  \code{\link{jobRemove}}, \code{\link{jobSetProgress}},
  \code{\link{jobSetState}}, \code{\link{jobSetStatus}}
}
\concept{jobs}