Class: RObject

RWorker.RObject

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new RObject(data)

Parameters

Name Type
data WebRData

Overrides

RObjectBase.constructor

Defined in

webR/robj-worker.ts:156

Properties

ptr

ptr: number

Inherited from

RObjectBase.ptr

Defined in

webR/robj-worker.ts:141

Accessors

[toStringTag]

get [toStringTag](): string

Returns

string

Defined in

webR/robj-worker.ts:169

Methods

attrs

attrs(): Nullable<RPairlist>

Returns

Nullable<RPairlist>

Defined in

webR/robj-worker.ts:195


get

get(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Defined in

webR/robj-worker.ts:237


getDollar

getDollar(prop): RObject

Parameters

Name Type
prop string

Returns

RObject

Defined in

webR/robj-worker.ts:241


includes

includes(name): null | boolean

Parameters

Name Type
name string

Returns

null | boolean

Defined in

webR/robj-worker.ts:224


inspect

inspect(): void

Returns

void

Defined in

webR/robj-worker.ts:183


isNull

isNull(): this is RNull

Returns

this is RNull

Defined in

webR/robj-worker.ts:187


isUnbound

isUnbound(): boolean

Returns

boolean

Defined in

webR/robj-worker.ts:191


names

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

Returns

null | (null | string)[]

Defined in

webR/robj-worker.ts:215


pluck

pluck(...path): undefined | RObject

Parameters

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

Returns

undefined | RObject

Defined in

webR/robj-worker.ts:261


set

set(prop, value): RObject

Parameters

Name Type
prop string | number
value RObject | WebRDataRaw

Returns

RObject

Defined in

webR/robj-worker.ts:277


setNames

setNames(values): RObject

Parameters

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

Returns

RObject

Defined in

webR/robj-worker.ts:199


subset

subset(prop): RObject

Parameters

Name Type
prop string | number

Returns

RObject

Defined in

webR/robj-worker.ts:233


toJs

toJs(options?, depth?): WebRDataJs

Parameters

Name Type Default value
options ToJsOptions undefined
depth number 1

Returns

WebRDataJs

Defined in

webR/robj-worker.ts:229


type

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

Returns

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

Inherited from

RObjectBase.type

Defined in

webR/robj-worker.ts:146


wrap

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

Type parameters

Name Type
T extends typeof RObject

Parameters

Name Type
this T
ptr number

Returns

InstanceType<T>

Defined in

webR/robj-worker.ts:164