Class: RFunction

RWorker.RFunction

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new RFunction(data): RFunction

Parameters

Name Type
data WebRData

Returns

RFunction

Inherited from

RObject.constructor

Defined in

webR/robj-worker.ts:192

Properties

ptr

• ptr: number

Inherited from

RObject.ptr

Defined in

webR/robj-worker.ts:177

Accessors

[toStringTag]

• get [toStringTag](): string

Returns

string

Inherited from

RObject.[toStringTag]

Defined in

webR/robj-worker.ts:206

Methods

attrs

▸ attrs(): Nullable<RPairlist>

Returns

Nullable<RPairlist>

Inherited from

RObject.attrs

Defined in

webR/robj-worker.ts:242

capture

▸ capture(options?, ...args): Object

Parameters

Name Type
options EvalROptions
...args (RObject | WebRDataRaw)[]

Returns

Object

Name Type
images ImageBitmap[]
output RList
result RObject

Defined in

webR/robj-worker.ts:778

exec

▸ exec(...args): RObject

Parameters

Name Type
...args (RObject | WebRDataRaw)[]

Returns

RObject

Defined in

webR/robj-worker.ts:766

get

▸ get(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Inherited from

RObject.get

Defined in

webR/robj-worker.ts:285

getDollar

▸ getDollar(prop): RObject

Parameters

Name Type
prop string

Returns

RObject

Inherited from

RObject.getDollar

Defined in

webR/robj-worker.ts:289

includes

▸ includes(name): null | boolean

Parameters

Name Type
name string

Returns

null | boolean

Inherited from

RObject.includes

Defined in

webR/robj-worker.ts:271

inspect

▸ inspect(): void

Returns

void

Inherited from

RObject.inspect

Defined in

webR/robj-worker.ts:220

isNa

▸ isNa(): boolean

Returns

boolean

Inherited from

RObject.isNa

Defined in

webR/robj-worker.ts:228

isNull

▸ isNull(): this is RNull

Returns

this is RNull

Inherited from

RObject.isNull

Defined in

webR/robj-worker.ts:224

isUnbound

▸ isUnbound(): boolean

Returns

boolean

Inherited from

RObject.isUnbound

Defined in

webR/robj-worker.ts:238

names

▸ names(): null | (null | string)[]

Returns

null | (null | string)[]

Inherited from

RObject.names

Defined in

webR/robj-worker.ts:262

pluck

▸ pluck(...path): undefined | RObject

Parameters

Name Type
...path (string | number)[]

Returns

undefined | RObject

Inherited from

RObject.pluck

Defined in

webR/robj-worker.ts:309

set

▸ set(prop, value): RObject

Parameters

Name Type
prop string | number
value RObject | WebRDataRaw

Returns

RObject

Inherited from

RObject.set

Defined in

webR/robj-worker.ts:325

setNames

▸ setNames(values): this

Parameters

Name Type
values null | (null | string)[]

Returns

this

Inherited from

RObject.setNames

Defined in

webR/robj-worker.ts:246

subset

▸ subset(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Inherited from

RObject.subset

Defined in

webR/robj-worker.ts:281

toJs

▸ toJs(options?, depth?): WebRDataJs

Parameters

Name Type Default value
options ToJsOptions undefined
depth number 1

Returns

WebRDataJs

Inherited from

RObject.toJs

Defined in

webR/robj-worker.ts:277

type

▸ type(): "string" | "symbol" | "function" | "null" | "pairlist" | "closure" | "environment" | "promise" | "call" | "special" | "builtin" | "logical" | "integer" | "double" | "complex" | "character" | "dots" | "any" | "list" | "expression" | "bytecode" | "pointer" | "weakref" | "raw" | "s4" | "new" | "free"

Returns

"string" | "symbol" | "function" | "null" | "pairlist" | "closure" | "environment" | "promise" | "call" | "special" | "builtin" | "logical" | "integer" | "double" | "complex" | "character" | "dots" | "any" | "list" | "expression" | "bytecode" | "pointer" | "weakref" | "raw" | "s4" | "new" | "free"

Inherited from

RObject.type

Defined in

webR/robj-worker.ts:182

wrap

▸ wrap<T>(this, ptr): InstanceType<T>

Type parameters

Name Type
T extends typeof RObject

Parameters

Name Type
this T
ptr number

Returns

InstanceType<T>

Inherited from

RObject.wrap

Defined in

webR/robj-worker.ts:200