Class: WebR
WebR.WebR
The webR class is used to initialize and interact with the webR system.
Start webR by constructing an instance of the WebR class, optionally passing an options argument of type WebROptions. WebR will begin to download and start a version of R built for WebAssembly in a worker thread.
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new WebR(options?
)
Parameters
Name | Type |
---|---|
options |
WebROptions |
Defined in
webR/webr-main.ts:206
Properties
FS
• FS: Object
Type declaration
Name | Type |
---|---|
lookupPath |
(path : string ) => Promise <FSNode > |
mkdir |
(path : string ) => Promise <FSNode > |
readFile |
(path : string , flags? : string ) => Promise <Uint8Array > |
rmdir |
(path : string ) => Promise <void > |
unlink |
(path : string ) => Promise <void > |
writeFile |
(path : string , data : ArrayBufferView , flags? : string ) => Promise <void > |
Defined in
webR/webr-main.ts:425
RCall
• RCall: ProxyConstructor
<typeof RCall
, RCall
>
Defined in
webR/webr-main.ts:193
RCharacter
• RCharacter: ProxyConstructor
<typeof RCharacter
, RCharacter
>
Defined in
webR/webr-main.ts:185
RComplex
• RComplex: ProxyConstructor
<typeof RComplex
, RComplex
>
Defined in
webR/webr-main.ts:186
RDouble
• RDouble: ProxyConstructor
<typeof RDouble
, RDouble
>
Defined in
webR/webr-main.ts:184
REnvironment
• REnvironment: ProxyConstructor
<typeof REnvironment
, REnvironment
>
Defined in
webR/webr-main.ts:190
RInteger
• RInteger: ProxyConstructor
<typeof RInteger
, RInteger
>
Defined in
webR/webr-main.ts:183
RList
• RList: ProxyConstructor
<typeof RList
, RList
>
Defined in
webR/webr-main.ts:188
RLogical
• RLogical: ProxyConstructor
<typeof RLogical
, RLogical
>
Defined in
webR/webr-main.ts:182
RObject
• RObject: ProxyConstructor
<typeof RObject
, RObject
>
Defined in
webR/webr-main.ts:181
RPairlist
• RPairlist: ProxyConstructor
<typeof RPairlist
, RPairlist
>
Defined in
webR/webr-main.ts:189
RRaw
• RRaw: ProxyConstructor
<typeof RRaw
, RRaw
>
Defined in
webR/webr-main.ts:187
RString
• RString: ProxyConstructor
<typeof RString
, RString
>
Defined in
webR/webr-main.ts:192
RSymbol
• RSymbol: ProxyConstructor
<typeof RSymbol
, RSymbol
>
Defined in
webR/webr-main.ts:191
Shelter
• Shelter: () => Promise
<Shelter
>
Type declaration
• new Shelter()
Defined in
webR/webr-main.ts:204
globalShelter
• globalShelter: Shelter
Defined in
webR/webr-main.ts:179
objs
• objs: Object
Type declaration
Name | Type |
---|---|
baseEnv |
REnvironment |
false |
RLogical |
globalEnv |
REnvironment |
na |
RLogical |
null |
RNull |
true |
RLogical |
Defined in
webR/webr-main.ts:195
Methods
close
▸ close(): void
Close the communication channel between the main thread and the worker thread cleanly. Once this has been executed, webR will be unable to continue.
Returns
void
Defined in
webR/webr-main.ts:295
destroy
▸ destroy(x
): Promise
<void
>
Destroy an R object reference.
Parameters
Name | Type | Description |
---|---|---|
x |
RObject |
An R object reference. |
Returns
Promise
<void
>
Defined in
webR/webr-main.ts:353
evalR
▸ evalR(code
, options?
): Promise
<RObject
>
Evaluate the given R code.
Stream outputs and any conditions raised during exectution are written to the JavaScript console.
Parameters
Name | Type | Description |
---|---|---|
code |
string |
The R code to evaluate. |
options? |
EvalROptions |
Options for the execution environment. |
Returns
Promise
<RObject
>
The result of the computation.
Defined in
webR/webr-main.ts:366
evalRBoolean
▸ evalRBoolean(code
, options?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<boolean
>
Defined in
webR/webr-main.ts:374
evalRNumber
▸ evalRNumber(code
, options?
): Promise
<number
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:378
evalRRaw
▸ evalRRaw(code
, outputType
, options?
): Promise
<void
>
Evaluate the given R code, returning the result as a raw JavaScript object.
Parameters
Name | Type | Description |
---|---|---|
code |
string |
The R code to evaluate. |
outputType |
"void" |
JavaScript type to return the result as. |
options? |
EvalROptions |
Options for the execution environment. |
Returns
Promise
<void
>
The result of the computation.
Defined in
webR/webr-main.ts:393
▸ evalRRaw(code
, outputType
, options?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"boolean" |
options? |
EvalROptions |
Returns
Promise
<boolean
>
Defined in
webR/webr-main.ts:394
▸ evalRRaw(code
, outputType
, options?
): Promise
<boolean
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"boolean[]" |
options? |
EvalROptions |
Returns
Promise
<boolean
[]>
Defined in
webR/webr-main.ts:395
▸ evalRRaw(code
, outputType
, options?
): Promise
<number
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"number" |
options? |
EvalROptions |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:396
▸ evalRRaw(code
, outputType
, options?
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"number[]" |
options? |
EvalROptions |
Returns
Promise
<number
[]>
Defined in
webR/webr-main.ts:397
▸ evalRRaw(code
, outputType
, options?
): Promise
<string
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"string" |
options? |
EvalROptions |
Returns
Promise
<string
>
Defined in
webR/webr-main.ts:398
▸ evalRRaw(code
, outputType
, options?
): Promise
<string
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"string[]" |
options? |
EvalROptions |
Returns
Promise
<string
[]>
Defined in
webR/webr-main.ts:399
evalRString
▸ evalRString(code
, options?
): Promise
<string
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<string
>
Defined in
webR/webr-main.ts:382
evalRVoid
▸ evalRVoid(code
, options?
): Promise
<void
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<void
>
Defined in
webR/webr-main.ts:370
flush
▸ flush(): Promise
<Message
[]>
Flush the output queue in the communication channel and return all output messages.
Returns
Promise
<Message
[]>
The output messages
Defined in
webR/webr-main.ts:312
init
▸ init(): Promise
<unknown
>
Returns
Promise
<unknown
>
A promise that resolves once webR has been intialised.
Defined in
webR/webr-main.ts:225
installPackages
▸ installPackages(packages
, quiet?
): Promise
<void
>
Install a list of R packages from the default webR CRAN-like repo.
Parameters
Name | Type | Default value | Description |
---|---|---|---|
packages |
string [] |
undefined |
An array of R pacakge names. |
quiet |
boolean |
false |
If true, do not output downloading messages. |
Returns
Promise
<void
>
Defined in
webR/webr-main.ts:342
interrupt
▸ interrupt(): void
Attempt to interrupt a running R computation.
Returns
void
Defined in
webR/webr-main.ts:333
invokeWasmFunction
▸ invokeWasmFunction(ptr
, ...args
): Promise
<number
>
Parameters
Name | Type |
---|---|
ptr |
number |
...args |
number [] |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:416
read
▸ read(): Promise
<Message
>
Read from the communication channel and return an output message.
Returns
Promise
<Message
>
The output message
Defined in
webR/webr-main.ts:303
write
▸ write(msg
): void
Send a message to the communication channel input queue.
Parameters
Name | Type | Description |
---|---|---|
msg |
Message |
Message to be added to the input queue. |
Returns
void
Defined in
webR/webr-main.ts:320
writeConsole
▸ writeConsole(input
): void
Send a line of standard input to the communication channel input queue.
Parameters
Name | Type | Description |
---|---|---|
input |
string |
Message to be added to the input queue. |
Returns
void
Defined in
webR/webr-main.ts:328