Module: RMain

Module for working with R objects on the main thead through JavaScript proxies. The RObject types in RMain are aliases for proxies to the corresponding types in RWorker. For instance, RMain.RCharacter is an alias for RMain.RProxy<RWorker.RCharacter>. The proxies automatically and asynchronously forward method and getter calls to the implementations on the R worker side.

Table of contents

Type Aliases

• RCall
• RCharacter
• RComplex
• RDataFrame
• RDouble
• REnvironment
• RFunction
• RInteger
• RList
• RLogical
• RNull
• RObject
• RPairlist
• RRaw
• RString
• RSymbol

Functions

• isRCall
• isRCharacter
• isRComplex
• isRDouble
• isREnvironment
• isRFunction
• isRInteger
• isRList
• isRLogical
• isRNull
• isRObject
• isRPairlist
• isRRaw
• isRSymbol

Type Aliases

RCall

Ƭ RCall: RProxy<RCall>

Defined in

webR/robj-main.ts:29

---

RCharacter

Ƭ RCharacter: RProxy<RCharacter>

Defined in

webR/robj-main.ts:25

---

RComplex

Ƭ RComplex: RProxy<RComplex>

Defined in

webR/robj-main.ts:24

---

RDataFrame

Ƭ RDataFrame: RProxy<RDataFrame>

Defined in

webR/robj-main.ts:27

---

RDouble

Ƭ RDouble: RProxy<RDouble>

Defined in

webR/robj-main.ts:23

---

REnvironment

Ƭ REnvironment: RProxy<REnvironment>

Defined in

webR/robj-main.ts:19

---

RFunction

Ƭ RFunction: RProxy<RFunction> & (…args: unknown[]) => Promise<unknown>

Defined in

webR/robj-main.ts:31

---

RInteger

Ƭ RInteger: RProxy<RInteger>

Defined in

webR/robj-main.ts:22

---

RList

Ƭ RList: RProxy<RList>

Defined in

webR/robj-main.ts:26

---

RLogical

Ƭ RLogical: RProxy<RLogical>

Defined in

webR/robj-main.ts:21

---

RNull

Ƭ RNull: RProxy<RNull>

Defined in

webR/robj-main.ts:16

---

RObject

Ƭ RObject: RProxy<RObject>

Defined in

webR/robj-main.ts:15

---

RPairlist

Ƭ RPairlist: RProxy<RPairlist>

Defined in

webR/robj-main.ts:18

---

RRaw

Ƭ RRaw: RProxy<RRaw>

Defined in

webR/robj-main.ts:28

---

RString

Ƭ RString: RProxy<RString>

Defined in

webR/robj-main.ts:20

---

RSymbol

Ƭ RSymbol: RProxy<RSymbol>

Defined in

webR/robj-main.ts:17

Functions

isRCall

▸ isRCall(value): value is RCall

Test for an RCall instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RCall

True if the object is an instance of an RCall.

Defined in

webR/robj-main.ts:153

---

isRCharacter

▸ isRCharacter(value): value is RCharacter

Test for an RCharacter instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RCharacter

True if the object is an instance of an RCharacter.

Defined in

webR/robj-main.ts:126

---

isRComplex

▸ isRComplex(value): value is RComplex

Test for an RComplex instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RComplex

True if the object is an instance of an RComplex.

Defined in

webR/robj-main.ts:117

---

isRDouble

▸ isRDouble(value): value is RDouble

Test for an RDouble instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RDouble

True if the object is an instance of an RDouble.

Defined in

webR/robj-main.ts:108

---

isREnvironment

▸ isREnvironment(value): value is REnvironment

Test for an REnvironment instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is REnvironment

True if the object is an instance of an REnvironment.

Defined in

webR/robj-main.ts:81

---

isRFunction

▸ isRFunction(value): value is RFunction

Test for an RFunction instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RFunction

True if the object is an instance of an RFunction.

Defined in

webR/robj-main.ts:162

---

isRInteger

▸ isRInteger(value): value is RInteger

Test for an RInteger instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RInteger

True if the object is an instance of an RInteger.

Defined in

webR/robj-main.ts:99

---

isRList

▸ isRList(value): value is RList

Test for an RList instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RList

True if the object is an instance of an RList.

Defined in

webR/robj-main.ts:135

---

isRLogical

▸ isRLogical(value): value is RLogical

Test for an RLogical instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RLogical

True if the object is an instance of an RLogical.

Defined in

webR/robj-main.ts:90

---

isRNull

▸ isRNull(value): value is RNull

Test for an RNull instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RNull

True if the object is an instance of an RNull.

Defined in

webR/robj-main.ts:54

---

isRObject

▸ isRObject(value): value is RObject

Test for an RObject instance

RObject is the user facing interface to R objects.

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RObject

True if the object is an instance of an RObject.

Defined in

webR/robj-main.ts:40

---

isRPairlist

▸ isRPairlist(value): value is RPairlist

Test for an RPairlist instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RPairlist

True if the object is an instance of an RPairlist.

Defined in

webR/robj-main.ts:72

---

isRRaw

▸ isRRaw(value): value is RRaw

Test for an RRaw instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RRaw

True if the object is an instance of an RRaw.

Defined in

webR/robj-main.ts:144

---

isRSymbol

▸ isRSymbol(value): value is RSymbol

Test for an RSymbol instance

Parameters

Name	Type	Description
value	any	The object to test.

Returns

value is RSymbol

True if the object is an instance of an RSymbol.

Defined in

webR/robj-main.ts:63