RInterface -- interface to R for statistical computing

Description

This package allows for the ability to interface with R for statistical computing inside Macaulay2.

i1 : dataFrame = RFunction "data.frame"

o1 = dataFrame

o1 : RFunction

i2 : chisqTest = RFunction "chisq.test"

o2 = chisqTest

o2 : RFunction

i3 : M = dataFrame(F => {762, 327, 468}, M => {484, 239, 477},
         "row.names" => {"Democrat", "Independent", "Republican"})

o3 =               F   M
     Democrat    762 484
     Independent 327 239
     Republican  468 477

o3 : RObject of type list

i4 : chisqTest M

o4 = 
             Pearson's Chi-squared test

     data:  structure(list(F = c(762L, 327L, 468L), M = c(484L, 239L, 477L)), class = "data.frame", row.names = c("Democrat", "Independent", "Republican"))
     X-squared = 30.07, df = 2, p-value = 2.954e-07


o4 : RObject of type list

i5 : value oo_"p.value"

o5 = 2.953589183211757e-7

o5 : RR (of precision 53)

Author

Doug Torrance <dtorrance@piedmont.edu>

Version

This documentation describes version 0.2 of RInterface, released May 7, 2026.

Citation

If you have used this package in your research, please cite it as follows:

@misc{RInterfaceSource,
  title = {{RInterface: interface to R for statistical computing. Version~0.2}},
  author = {Doug Torrance},
  howpublished = {A \emph{Macaulay2} package available at
    \url{https://github.com/Macaulay2/M2/tree/stable/M2/Macaulay2/packages}}
}

Exports

Types
- RContext -- R context
- RFunction -- R function
- RObject -- R object
Functions and commands
- library -- load an R package
- RQuote -- create an unevaluated R symbol
- RSymbol -- look up an R object by name
- RValue -- evaluate R code
Methods
- ~ RObject -- bitwise NOT of an R object, or create a one-sided formula
- abs(RObject) -- absolute value of an R object
- acos(RObject) -- arccosine of an R object
- acosh(RObject) -- hyperbolic arccosine of an R object
- asin(RObject) -- arcsine of an R object
- asinh(RObject) -- hyperbolic arcsine of an R object
- atan(RObject) -- arctangent of an R object
- atan2(RObject,RObject) -- two-argument arctangent of R objects
- atan2(RObject,Thing) -- see atan2(RObject,RObject) -- two-argument arctangent of R objects
- atan2(Thing,RObject) -- see atan2(RObject,RObject) -- two-argument arctangent of R objects
- atanh(RObject) -- hyperbolic arctangent of an R object
- Beta(RObject,RObject) -- beta function of R objects
- Beta(RObject,Thing) -- see Beta(RObject,RObject) -- beta function of R objects
- Beta(Thing,RObject) -- see Beta(RObject,RObject) -- beta function of R objects
- binomial(RObject,RObject) -- binomial coefficient of R objects
- binomial(RObject,Thing) -- see binomial(RObject,RObject) -- binomial coefficient of R objects
- binomial(Thing,RObject) -- see binomial(RObject,RObject) -- binomial coefficient of R objects
- ceiling(RObject) -- ceiling of an R object
- conjugate(RObject) -- complex conjugate of an R object
- cos(RObject) -- cosine of an R object
- cosh(RObject) -- hyperbolic cosine of an R object
- Digamma(RObject) -- digamma function of an R object
- exp(RObject) -- exponential of an R object
- expm1(RObject) -- exponential minus 1 of an R object
- floor(RObject) -- floor of an R object
- Gamma(RObject) -- gamma function of an R object
- imaginaryPart(RObject) -- imaginary part of an R object
- iterator(RObject) -- iterate through an R object
- length(RObject) -- the length of an R object
- listSymbols(RContext) -- see listSymbols(RObject) -- list symbols in an R environment
- listSymbols(RObject) -- list symbols in an R environment
- lngamma(RObject) -- log-gamma function of an R object
- log(RObject) -- natural logarithm of an R object
- log1p(RObject) -- natural logarithm of 1 plus an R object
- max(RObject) -- maximum of an R object
- min(RObject) -- minimum of an R object
- new RContext from String -- construct an R context
- new RObject from Boolean -- create an R logical vector from a Boolean
- new RObject from CC -- create an R complex vector from a complex number
- new RObject from HashTable -- create an R environment from a hash table
- new RObject from List -- create an R vector from a list
- new RObject from Matrix -- create an R matrix from a Macaulay2 matrix
- ?? RObject -- see new RObject from Nothing -- create an R NULL object
- new RObject from Nothing -- create an R NULL object
- new RObject from Number -- see new RObject from RR -- create an R double vector from a real or rational number
- new RObject from RR -- create an R double vector from a real or rational number
- new RObject from Sequence -- create an R pairlist from a sequence
- new RObject from String -- create an R character vector from a string
- new RObject from Symbol -- create an R character vector from a symbol
- new RObject from ZZ -- create an R integer vector from an integer
- not RObject -- logical negation of an R object
- product(RObject) -- product of elements of an R object
- new RContext -- see RContext -- R context
- RContext _ String -- get a variable from an R context
- RContext String -- evaluate R code in a context
- realPart(RObject) -- real part of an R object
- new RFunction from RObject -- see RFunction -- R function
- new RFunction from String -- see RFunction -- R function
- new RFunction from Thing -- see RFunction -- R function
- net(RObject) -- see RObject -- R object
- toString(RObject) -- see RObject -- R object
- RObject ! -- factorial of an R object
- RObject % RObject -- modulo of R objects
- RObject % Thing -- see RObject % RObject -- modulo of R objects
- Thing % RObject -- see RObject % RObject -- modulo of R objects
- RObject & RObject -- bitwise AND of R objects
- RObject & Thing -- see RObject & RObject -- bitwise AND of R objects
- Thing & RObject -- see RObject & RObject -- bitwise AND of R objects
- RObject * RObject -- multiply R objects
- RObject * Thing -- see RObject * RObject -- multiply R objects
- Thing * RObject -- see RObject * RObject -- multiply R objects
- + RObject -- see RObject + RObject -- add R objects
- RObject + RObject -- add R objects
- RObject + Thing -- see RObject + RObject -- add R objects
- Thing + RObject -- see RObject + RObject -- add R objects
- - RObject -- see RObject - RObject -- subtract R objects
- RObject - RObject -- subtract R objects
- RObject - Thing -- see RObject - RObject -- subtract R objects
- Thing - RObject -- see RObject - RObject -- subtract R objects
- RObject / RObject -- divide R objects
- RObject / Thing -- see RObject / RObject -- divide R objects
- Thing / RObject -- see RObject / RObject -- divide R objects
- RObject // RObject -- floor division of R objects
- RObject // Thing -- see RObject // RObject -- floor division of R objects
- Thing // RObject -- see RObject // RObject -- floor division of R objects
- RObject .. RObject -- see RObject : RObject -- R colon operator
- RObject .. Thing -- see RObject : RObject -- R colon operator
- RObject : RObject -- R colon operator
- RObject : Thing -- see RObject : RObject -- R colon operator
- Thing .. RObject -- see RObject : RObject -- R colon operator
- Thing : RObject -- see RObject : RObject -- R colon operator
- RObject << RObject -- bitwise left shift of an R object
- RObject << Thing -- see RObject << RObject -- bitwise left shift of an R object
- Thing << RObject -- see RObject << RObject -- bitwise left shift of an R object
- RObject == RObject -- equality of R objects
- RObject == Thing -- see RObject == RObject -- equality of R objects
- Thing == RObject -- see RObject == RObject -- equality of R objects
- RObject >> RObject -- bitwise right shift of an R object
- RObject >> Thing -- see RObject >> RObject -- bitwise right shift of an R object
- Thing >> RObject -- see RObject >> RObject -- bitwise right shift of an R object
- RObject ? RObject -- comparison of R objects
- RObject ? Thing -- see RObject ? RObject -- comparison of R objects
- Thing ? RObject -- see RObject ? RObject -- comparison of R objects
- RObject ^ RObject -- exponentiation of R objects
- RObject ^ Thing -- see RObject ^ RObject -- exponentiation of R objects
- Thing ^ RObject -- see RObject ^ RObject -- exponentiation of R objects
- RObject ^^ RObject -- bitwise XOR of R objects
- RObject ^^ Thing -- see RObject ^^ RObject -- bitwise XOR of R objects
- Thing ^^ RObject -- see RObject ^^ RObject -- bitwise XOR of R objects
- RObject _ Thing -- extract a single element of an R object
- RObject _ Thing = Thing -- replace a single element of an R object
- RObject | RObject -- bitwise OR of R objects
- RObject | Thing -- see RObject | RObject -- bitwise OR of R objects
- Thing | RObject -- see RObject | RObject -- bitwise OR of R objects
- RObject ~ RObject -- create a two-sided R formula
- RObject ~ Thing -- see RObject ~ RObject -- create a two-sided R formula
- Thing ~ RObject -- see RObject ~ RObject -- create a two-sided R formula
- RObject and RObject -- logical conjunction of R objects
- RObject and Thing -- see RObject and RObject -- logical conjunction of R objects
- Thing and RObject -- see RObject and RObject -- logical conjunction of R objects
- RObject Array -- extract multiple elements of an R object
- RObject or RObject -- logical disjunction of R objects
- RObject or Thing -- see RObject or RObject -- logical disjunction of R objects
- Thing or RObject -- see RObject or RObject -- logical disjunction of R objects
- RObject SPACE Array = Thing -- replace multiple elements of an R object
- RObject xor RObject -- logical exclusive disjunction of R objects
- RObject xor Thing -- see RObject xor RObject -- logical exclusive disjunction of R objects
- Thing xor RObject -- see RObject xor RObject -- logical exclusive disjunction of R objects
- round(RObject) -- see round(RObject,RObject) -- rounding of an R object
- round(RObject,RObject) -- rounding of an R object
- round(RObject,Thing) -- see round(RObject,RObject) -- rounding of an R object
- round(Thing,RObject) -- see round(RObject,RObject) -- rounding of an R object
- RQuote(String) -- see RQuote -- create an unevaluated R symbol
- RQuote(Thing) -- see RQuote -- create an unevaluated R symbol
- RSymbol(String) -- see RSymbol -- look up an R object by name
- RSymbol(Thing) -- see RSymbol -- look up an R object by name
- RValue(Sequence) -- see RValue -- evaluate R code
- RValue(String) -- see RValue -- evaluate R code
- sin(RObject) -- sine of an R object
- sinh(RObject) -- hyperbolic sine of an R object
- sqrt(RObject) -- square root of an R object
- sum(RObject) -- sum of elements of an R object
- tan(RObject) -- tangent of an R object
- tanh(RObject) -- hyperbolic tangent of an R object
- truncate(RObject) -- truncation of an R object
- use(RContext) -- import R context variables into Macaulay2
- value(RObject) -- convert R object to Macaulay2
Symbols
- Environment -- see RValue -- evaluate R code
Other things
- NA -- missing value

For the programmer

The object RInterface is a package, defined in RInterface.m2, with auxiliary files in RInterface/.

The source of this document is in /build/reproducible-path/macaulay2-1.26.05+ds/M2/Macaulay2/packages/RInterface/doc.m2:28:0.