ROOT::R::TRFunctionImport Class Reference

This is a class to pass functions from ROOT to R.

TRFunctionImport class

The TRFunctionImport class lets you call R's functions to ROOT's environment
The object associated to this class have a set of overloaded operators to use the object like function

#include<TRInterface.h>
 
using namespace ROOT::R;
void Function()
{
  TRInterface &r = TRInterface::Instance();
  r.SetVerbose(1);
  ////////////////////////////////////////
  //defining functions to be used from R//
  ////////////////////////////////////////
  TRFunctionImport c("c");
  TRFunctionImport list("list");
  TRFunctionImport asformula("as.formula");
  TRFunctionImport nls("nls");
  TRFunctionImport confint("confint");
  TRFunctionImport summary("summary");
  TRFunctionImport print("print");
  TRFunctionImport plot("plot");
  TRFunctionImport lines("lines");
  TRFunctionImport devnew("dev.new");
  TRFunctionImport devoff("dev.off");
  TRFunctionImport min("min");
  TRFunctionImport max("max");
  TRFunctionImport seq("seq");
  TRFunctionImport predict("predict");
 
r<<"options(device='png')";//enable plot in png file
 
  ////////////////////////
  //doing the procedure //
  ////////////////////////
   TRObject xdata = c(-2,-1.64,-1.33,-0.7,0,0.45,1.2,1.64,2.32,2.9);
   TRObject ydata = c(0.699369,0.700462,0.695354,1.03905,1.97389,2.41143,1.91091,0.919576,-0.730975,-1.42001);
 
   TRDataFrame data;
   data["xdata"]=xdata;
   data["ydata"]=ydata;
 
   //fit = nls(ydata ~ p1*cos(p2*xdata) + p2*sin(p1*xdata), start=list(p1=1,p2=0.2)) <- R code
   TRObject fit = nls(asformula("ydata ~ p1*cos(p2*xdata) + p2*sin(p1*xdata)"),Label["data"]=data, Label["start"]=list(Label["p1"]=1,Label["p2"]=0.2));
   print(summary(fit));
 
   print(confint(fit));
 
   devnew("Fitting Regression");
   plot(xdata,ydata);
 
   TRObject xgrid=seq(min(xdata),max(xdata),Label["len"]=10);
   lines(xgrid,predict(fit,xgrid),Label["col"] = "green");
   devoff();
}

Output

Formula: ydata ~ p1 * cos(p2 * xdata) + p2 * sin(p1 * xdata)
 
Parameters:
   Estimate Std. Error t value Pr(>|t|)
p1 1.881851   0.027430   68.61 2.27e-12 ***
p2 0.700230   0.009153   76.51 9.50e-13 ***
---
Signif. codes:  0 ‘***’ 0.001 ‘**’ 0.01 ‘*’ 0.05 ‘.’ 0.1 ‘ ’ 1
 
Residual standard error: 0.08202 on 8 degrees of freedom
 
Number of iterations to convergence: 7
Achieved convergence tolerance: 2.189e-06
 
Waiting for profiling to be done...
        2.5%     97.5%
p1 1.8206081 1.9442365
p2 0.6794193 0.7209843

Users Guide

https://oproject.org/pages/ROOT R Users Guide

Definition at line 114 of file TRFunctionImport.h.

Public Member Functions
	TRFunctionImport (const TRFunctionImport &fun)
	TRFunctionImport copy constructor.
	TRFunctionImport (const TString &name)
	TRFunctionImport constructor.
	TRFunctionImport (const TString &name, const TString &ns)
	TRFunctionImport constructor.
	TRFunctionImport (SEXP obj)
	TRFunctionImport constructor.
	TRFunctionImport (TRObject &obj)
	TRFunctionImport constructor.
	~TRFunctionImport ()
virtual TClass *	IsA () const
SEXP	operator() ()
virtual void	Streamer (TBuffer &)
	Stream an object of class TObject.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.
	TObject (const TObject &object)
	TObject copy ctor.
virtual	~TObject ()
	TObject destructor.
void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.
virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.
ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.
virtual const char *	ClassName () const
	Returns name of class to which the object belongs.
virtual void	Clear (Option_t *="")
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.
virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method.
virtual void	Copy (TObject &object) const
	Copy this to obj.
virtual void	Delete (Option_t *option="")
	Delete this object.
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.
virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1).
virtual void	Dump () const
	Dump contents of object on stdout.
virtual void	Error (const char *method, const char *msgfmt,...) const
	Issue error message.
virtual void	Execute (const char *method, const char *params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g.
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray.
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message.
virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.
virtual const char *	GetIconName () const
	Returns mime type name of object.
virtual const char *	GetName () const
	Returns name of object.
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).
virtual Option_t *	GetOption () const
virtual const char *	GetTitle () const
	Returns title of object.
virtual UInt_t	GetUniqueID () const
	Return the unique object id.
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.
virtual ULong_t	Hash () const
	Return hash value for this object.
Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.
virtual void	Info (const char *method, const char *msgfmt,...) const
	Issue info message.
virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".
virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.
virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.
void	InvertBit (UInt_t f)
Bool_t	IsDestructed () const
	IsDestructed.
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).
virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
virtual Bool_t	IsSortable () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout.
void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.
void	operator delete (void *ptr)
	Operator delete.
void	operator delete[] (void *ptr)
	Operator delete [].
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *vp)
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, void *vp)
TObject &	operator= (const TObject &rhs)
	TObject assignment operator.
virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.
virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.
virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself.
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.
virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.
void	ResetBit (UInt_t f)
virtual void	SaveAs (const char *filename="", Option_t *option="") const
	Save this object in the file specified by filename.
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message.
R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const
Int_t	TestBits (UInt_t f) const
virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.
virtual void	Warning (const char *method, const char *msgfmt,...) const
	Issue warning message.
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Static Public Member Functions
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
Static Public Member Functions inherited from TObject
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Longptr_t	GetDtorOnly ()
	Return destructor only flag.
static Bool_t	GetObjectStat ()
	Get status of object stat flag.
static void	SetDtorOnly (void *obj)
	Set destructor only flag.
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Protected Member Functions
	TRFunctionImport (const Rcpp::Function &fun)
	TRFunctionImport constructor for Rcpp::DataFrame.
Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char *location, const char *fmt, va_list va) const
	Interface to ErrorHandler (protected).
void	MakeZombie ()

Protected Attributes
Rcpp::Function *	f

Friends
TRFunctionImport	Rcpp::as (SEXP)
SEXP	Rcpp::wrap (const TRFunctionImport &f)
class	TRInterface

Additional Inherited Members
Public Types inherited from TObject
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
enum	EStatusBits {   kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,   kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 3 )) }

#include <TRFunctionImport.h>

Inheritance diagram for ROOT::R::TRFunctionImport:

Constructor & Destructor Documentation

TRFunctionImport() [1/6]

ROOT::R::TRFunctionImport::TRFunctionImport ( const Rcpp::Function &  fun )

inlineprotected

TRFunctionImport constructor for Rcpp::DataFrame.

Parameters

fun	raw function object from Rcpp

Definition at line 126 of file TRFunctionImport.h.

TRFunctionImport() [2/6]

TRFunctionImport::TRFunctionImport

(

const TString &

name

)

TRFunctionImport constructor.

Parameters

name	name of function from R

Definition at line 31 of file TRFunctionImport.cxx.

TRFunctionImport() [3/6]

TRFunctionImport::TRFunctionImport	(	const TString &	name,
		const TString &	ns
	)

TRFunctionImport constructor.

Parameters

name	name of function from R
ns	namespace of function from R

Definition at line 37 of file TRFunctionImport.cxx.

TRFunctionImport() [4/6]

TRFunctionImport::TRFunctionImport

(

const TRFunctionImport &

fun

)

TRFunctionImport copy constructor.

Parameters

fun	other TRFunctionImport

Definition at line 25 of file TRFunctionImport.cxx.

TRFunctionImport() [5/6]

TRFunctionImport::TRFunctionImport

(

SEXP

obj

)

TRFunctionImport constructor.

Parameters

obj	raw R object

Definition at line 49 of file TRFunctionImport.cxx.

TRFunctionImport() [6/6]

TRFunctionImport::TRFunctionImport

(

TRObject &

obj

)

TRFunctionImport constructor.

Parameters

obj	TRObject object

Definition at line 43 of file TRFunctionImport.cxx.

~TRFunctionImport()

ROOT::R::TRFunctionImport::~TRFunctionImport ( )

inline

Definition at line 159 of file TRFunctionImport.h.

Member Function Documentation

Class()

static TClass * ROOT::R::TRFunctionImport::Class ( )

static

Returns

TClass describing this class

Class_Name()

static const char * ROOT::R::TRFunctionImport::Class_Name ( )

static

Returns

Name of this class

Class_Version()

static constexpr Version_t ROOT::R::TRFunctionImport::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 168 of file TRFunctionImport.h.

DeclFileName()

static const char * ROOT::R::TRFunctionImport::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 168 of file TRFunctionImport.h.

IsA()

virtual TClass * ROOT::R::TRFunctionImport::IsA ( ) const

inlinevirtual

Returns

TClass describing current object

Reimplemented from TObject.

Definition at line 168 of file TRFunctionImport.h.

operator()()

SEXP ROOT::R::TRFunctionImport::operator() ( )

inline

Definition at line 163 of file TRFunctionImport.h.

Streamer()

virtual void ROOT::R::TRFunctionImport::Streamer ( TBuffer &  R__b )

virtual

Stream an object of class TObject.

Reimplemented from TObject.

StreamerNVirtual()

void ROOT::R::TRFunctionImport::StreamerNVirtual ( TBuffer &  ClassDef_StreamerNVirtual_b )

inline

Definition at line 168 of file TRFunctionImport.h.

Friends And Related Symbol Documentation

Rcpp::as

TRFunctionImport Rcpp::as ( SEXP  )

friend

Rcpp::wrap

SEXP Rcpp::wrap ( const TRFunctionImport &  f )

friend

TRInterface

friend class TRInterface

friend

Definition at line 115 of file TRFunctionImport.h.

Member Data Documentation

f

Rcpp::Function* ROOT::R::TRFunctionImport::f

protected

Definition at line 120 of file TRFunctionImport.h.

Libraries for ROOT::R::TRFunctionImport:

---

The documentation for this class was generated from the following files:

• bindings/r/inc/TRFunctionImport.h
• bindings/r/src/TRFunctionImport.cxx