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?
): WebR
Parameters
Name | Type |
---|---|
options |
WebROptions |
Returns
Defined in
webR/webr-main.ts:233
Properties
FS
• FS: Object
Type declaration
Name | Type |
---|---|
lookupPath |
(path : string ) => Promise <FSNode > |
mkdir |
(path : string ) => Promise <FSNode > |
mount |
<T>(type : T , options : FSMountOptions <T >, mountpoint : string ) => Promise <void > |
readFile |
(path : string , flags? : string ) => Promise <Uint8Array > |
rmdir |
(path : string ) => Promise <void > |
syncfs |
(populate : boolean ) => Promise <void > |
unlink |
(path : string ) => Promise <void > |
unmount |
(mountpoint : string ) => Promise <void > |
writeFile |
(path : string , data : ArrayBufferView , flags? : string ) => Promise <void > |
Defined in
webR/webr-main.ts:459
RCall
• RCall: ProxyConstructor
<typeof RCall
, RCall
>
Defined in
webR/webr-main.ts:220
RCharacter
• RCharacter: ProxyConstructor
<typeof RCharacter
, RCharacter
>
Defined in
webR/webr-main.ts:211
RComplex
• RComplex: ProxyConstructor
<typeof RComplex
, RComplex
>
Defined in
webR/webr-main.ts:212
RDataFrame
• RDataFrame: ProxyConstructor
<typeof RDataFrame
, RDataFrame
>
Defined in
webR/webr-main.ts:215
RDouble
• RDouble: ProxyConstructor
<typeof RDouble
, RDouble
>
Defined in
webR/webr-main.ts:210
REnvironment
• REnvironment: ProxyConstructor
<typeof REnvironment
, REnvironment
>
Defined in
webR/webr-main.ts:217
RInteger
• RInteger: ProxyConstructor
<typeof RInteger
, RInteger
>
Defined in
webR/webr-main.ts:209
RList
• RList: ProxyConstructor
<typeof RList
, RList
>
Defined in
webR/webr-main.ts:214
RLogical
• RLogical: ProxyConstructor
<typeof RLogical
, RLogical
>
Defined in
webR/webr-main.ts:208
RObject
• RObject: ProxyConstructor
<typeof RObject
, RObject
>
Defined in
webR/webr-main.ts:207
RPairlist
• RPairlist: ProxyConstructor
<typeof RPairlist
, RPairlist
>
Defined in
webR/webr-main.ts:216
RRaw
• RRaw: ProxyConstructor
<typeof RRaw
, RRaw
>
Defined in
webR/webr-main.ts:213
RString
• RString: ProxyConstructor
<typeof RString
, RString
>
Defined in
webR/webr-main.ts:219
RSymbol
• RSymbol: ProxyConstructor
<typeof RSymbol
, RSymbol
>
Defined in
webR/webr-main.ts:218
Shelter
• Shelter: () => Promise
<Shelter
>
Type declaration
• new Shelter(): Promise
<Shelter
>
Returns
Promise
<Shelter
>
Defined in
webR/webr-main.ts:231
globalShelter
• globalShelter: Shelter
Defined in
webR/webr-main.ts:204
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:222
version
• version: string
= WEBR_VERSION
Defined in
webR/webr-main.ts:205
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:324
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:387
evalR
▸ evalR(code
, options?
): Promise
<RObject
>
Evaluate the given R code.
Stream outputs and any conditions raised during execution 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:400
evalRBoolean
▸ evalRBoolean(code
, options?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<boolean
>
Defined in
webR/webr-main.ts:408
evalRNumber
▸ evalRNumber(code
, options?
): Promise
<number
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:412
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:427
▸ evalRRaw(code
, outputType
, options?
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"boolean" |
options? |
EvalROptions |
Returns
Promise
<boolean
>
Defined in
webR/webr-main.ts:428
▸ evalRRaw(code
, outputType
, options?
): Promise
<boolean
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"boolean[]" |
options? |
EvalROptions |
Returns
Promise
<boolean
[]>
Defined in
webR/webr-main.ts:429
▸ evalRRaw(code
, outputType
, options?
): Promise
<number
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"number" |
options? |
EvalROptions |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:430
▸ evalRRaw(code
, outputType
, options?
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"number[]" |
options? |
EvalROptions |
Returns
Promise
<number
[]>
Defined in
webR/webr-main.ts:431
▸ evalRRaw(code
, outputType
, options?
): Promise
<string
>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"string" |
options? |
EvalROptions |
Returns
Promise
<string
>
Defined in
webR/webr-main.ts:432
▸ evalRRaw(code
, outputType
, options?
): Promise
<string
[]>
Parameters
Name | Type |
---|---|
code |
string |
outputType |
"string[]" |
options? |
EvalROptions |
Returns
Promise
<string
[]>
Defined in
webR/webr-main.ts:433
evalRString
▸ evalRString(code
, options?
): Promise
<string
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<string
>
Defined in
webR/webr-main.ts:416
evalRVoid
▸ evalRVoid(code
, options?
): Promise
<void
>
Parameters
Name | Type |
---|---|
code |
string |
options? |
EvalROptions |
Returns
Promise
<void
>
Defined in
webR/webr-main.ts:404
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:341
init
▸ init(): Promise
<unknown
>
Returns
Promise
<unknown
>
A promise that resolves once webR has been initialised.
Defined in
webR/webr-main.ts:282
installPackages
▸ installPackages(packages
, options?
): Promise
<void
>
Install a list of R packages from Wasm binary package repositories.
Parameters
Name | Type | Description |
---|---|---|
packages |
string | string [] |
An string or array of strings containing R package names. |
options? |
InstallPackagesOptions |
Options to be used when installing webR packages. |
Returns
Promise
<void
>
Defined in
webR/webr-main.ts:373
interrupt
▸ interrupt(): void
Attempt to interrupt a running R computation.
Returns
void
Defined in
webR/webr-main.ts:362
invokeWasmFunction
▸ invokeWasmFunction(ptr
, ...args
): Promise
<number
>
Parameters
Name | Type |
---|---|
ptr |
number |
...args |
number [] |
Returns
Promise
<number
>
Defined in
webR/webr-main.ts:450
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:332
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:349
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:357