Class: RFunction

RWorker.RFunction

Hierarchy

• RObject

  ↳ RFunction

Table of contents

Constructors

• constructor

Properties

• ptr

Accessors

• [toStringTag]

Methods

• attrs
• capture
• class
• exec
• get
• getDollar
• includes
• inspect
• isNa
• isNull
• isUnbound
• names
• pluck
• set
• setNames
• subset
• toJs
• type
• wrap

Constructors

constructor

• new RFunction(data): RFunction

Parameters

Name	Type
data	WebRData

Returns

RFunction

Inherited from

RObject.constructor

Defined in

webR/robj-worker.ts:198

Properties

ptr

• ptr: number

Inherited from

RObject.ptr

Defined in

webR/robj-worker.ts:183

Accessors

[toStringTag]

• get [toStringTag](): string

Returns

string

Inherited from

RObject.[toStringTag]

Defined in

webR/robj-worker.ts:212

Methods

attrs

▸ attrs(): Nullable<RPairlist>

Returns

Nullable<RPairlist>

Inherited from

RObject.attrs

Defined in

webR/robj-worker.ts:248

---

capture

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

Parameters

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

Returns

Object

Name	Type
images	ImageBitmap[]
output	RList
result	RObject

Defined in

webR/robj-worker.ts:800

---

class

▸ class(): RCharacter

Returns

RCharacter

Inherited from

RObject.class

Defined in

webR/robj-worker.ts:252

---

exec

▸ exec(...args): RObject

Parameters

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

Returns

RObject

Defined in

webR/robj-worker.ts:788

---

get

▸ get(prop): RObject

Parameters

Name	Type
prop	string | number

Returns

RObject

Inherited from

RObject.get

Defined in

webR/robj-worker.ts:302

---

getDollar

▸ getDollar(prop): RObject

Parameters

Name	Type
prop	string

Returns

RObject

Inherited from

RObject.getDollar

Defined in

webR/robj-worker.ts:306

---

includes

▸ includes(name): null | boolean

Parameters

Name	Type
name	string

Returns

null | boolean

Inherited from

RObject.includes

Defined in

webR/robj-worker.ts:288

---

inspect

▸ inspect(): void

Returns

void

Inherited from

RObject.inspect

Defined in

webR/robj-worker.ts:226

---

isNa

▸ isNa(): boolean

Returns

boolean

Inherited from

RObject.isNa

Defined in

webR/robj-worker.ts:234

---

isNull

▸ isNull(): this is RNull

Returns

this is RNull

Inherited from

RObject.isNull

Defined in

webR/robj-worker.ts:230

---

isUnbound

▸ isUnbound(): boolean

Returns

boolean

Inherited from

RObject.isUnbound

Defined in

webR/robj-worker.ts:244

---

names

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

Returns

null | (null | string)[]

Inherited from

RObject.names

Defined in

webR/robj-worker.ts:279

---

pluck

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

Parameters

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

Returns

undefined | RObject

Inherited from

RObject.pluck

Defined in

webR/robj-worker.ts:326

---

set

▸ set(prop, value): RObject

Parameters

Name	Type
prop	string | number
value	WebRDataRaw | RObject

Returns

RObject

Inherited from

RObject.set

Defined in

webR/robj-worker.ts:342

---

setNames

▸ setNames(values): this

Parameters

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

Returns

this

Inherited from

RObject.setNames

Defined in

webR/robj-worker.ts:263

---

subset

▸ subset(prop): RObject

Parameters

Name	Type
prop	string | number

Returns

RObject

Inherited from

RObject.subset

Defined in

webR/robj-worker.ts:298

---

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:294

---

type

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

Returns

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

Inherited from

RObject.type

Defined in

webR/robj-worker.ts:188

---

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:206