This is a class to create DataFrames from ROOT to R.

TRDataFrame class

DataFrame is a very important datatype in R and in ROOTR we have a class to manipulate
dataframes called TRDataFrame, with a lot of very useful operators overloaded to work with TRDataFrame's objects
in a similar way that in the R environment but from c++ in ROOT.
Example:

Lets to create need data to play with dataframe features

Creating variables

TVectorD v1(3);
std::vector<Double_t> v2(3);
std::array<Int_t,3>  v3{ {1,2,3} };
std::list<std::string> names;

Assigning values

v1[0]=1;
v1[1]=2;
v1[2]=3;
 
v2[0]=0.101;
v2[1]=0.202;
v2[2]=0.303;
 
names.push_back("v1");
names.push_back("v2");
names.push_back("v3");
 
ROOT::R::TRInterface &r=ROOT::R::TRInterface::Instance();

In R the dataframe have associate to every column a label, in ROOTR you can have the same label using the class ROOT::R::Label to create a TRDataFrame where you data have a label associate.

Creating dataframe object with its labels

using namespace ROOT::R;

TRDataFrame df1(Label["var1"]=v1,Label["var2"]=v2,Label["var3"]=v3,Label["strings"]=names);

ROOT::R::TRDataFrame

This is a class to create DataFrames from ROOT to R.

Definition TRDataFrame.h:176

ROOT::R

namespace associated R package for ROOT.

Definition RExports.h:71

ROOT::R::Label

const Rcpp::internal::NamedPlaceHolder & Label

Passing dataframe to R's environment

r["df1"]<<df1;

r<<"print(df1)";

Output

var1  var2 var3 strings
  1 0.101    1      v1
  2 0.202    2      v2
  3 0.303    3      v3

Manipulating data between dataframes

Adding colunms to dataframe

TVectorD v4(3);
//filling the vector fro R's environment
r["c(-1,-2,-3)"]>>v4;
//adding new colunm to df1 with name var4
df1["var4"]=v4;
//updating df1 in R's environment
r["df1"]<<df1;
//printing df1
r<<"print(df1)";

Output var1 var2 var3 strings var4 1 1 0.101 1 v1 -1 2 2 0.202 2 v2 -2 3 3 0.303 3 v3 -3

Getting dataframe from R's environment

ROOT::R::TRDataFrame df2;
 
r<<"df2<-data.frame(v1=c(0.1,0.2,0.3),v2=c(3,2,1))";
r["df2"]>>df2;
 
TVectorD v(3);
df2["v1"]>>v;
v.Print();
 
df2["v2"]>>v;
v.Print();

Output

Vector (3)  is as follows
 
     |        1  |
------------------
   0 |0.1
   1 |0.2
   2 |0.3
 
Vector (3)  is as follows
 
     |        1  |
------------------
   0 |3
   1 |2
   2 |1

Working with colunms between dataframes

df2["v3"]<<df1["strings"];
 
//updating df2 in R's environment
r["df2"]<<df2;
r<<"print(df2)";

Output

v1 v2 v3
0.1  3 v1
0.2  2 v2
0.3  1 v3

Working with colunms between dataframes

//passing values from colunm v3 of df2 to var1 of df1
df2["v3"]>>df1["var1"];
//updating df1 in R's environment
r["df1"]<<df1;
r<<"print(df1)";

Output

var1  var2 var3 strings var4
 v1 0.101    1      v1   -1
 v2 0.202    2      v2   -2
 v3 0.303    3      v3   -3

Users Guide

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

Definition at line 176 of file TRDataFrame.h.

Classes
class	Binding

Public Member Functions
	TRDataFrame ()
	Default TDataFrame constructor.

	TRDataFrame (const Rcpp::DataFrame &_df)
	TDataFrame constructor for Rcpp::DataFrame.

	TRDataFrame (const TRDataFrame &_df)
	TDataFrame copy constructor.

	TRDataFrame (SEXP obj)
	TDataFrame constructor.

template<class T >
TMatrixT< T >	AsMatrix ()
	Method to get dataframe as matrix.

TVectorString	GetColNames ()
	Method to get labels of dataframe.

Int_t	GetNcols ()
	Method to get the number of columns.

Int_t	GetNrows ()
	Method to get the number of rows.

virtual TClass *	IsA () const

	operator SEXP ()

	operator SEXP () const

TRDataFrame &	operator= (SEXP obj)

TRDataFrame &	operator= (TRDataFrame &obj)

TRDataFrame &	operator= (TRDataFrame obj)

Binding	operator[] (const TString &name)

void	Print (const Char_t *label="")
	Method to print the dataframe in stdout or a column given the label.

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 Attributes
Rcpp::DataFrame	df

Friends
SEXP	Rcpp::wrap (const TRDataFrame &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 )) }

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 ()

#include <TRDataFrame.h>

Inheritance diagram for ROOT::R::TRDataFrame:

[legend]

Constructor & Destructor Documentation

◆ TRDataFrame() [1/4]

TRDataFrame::TRDataFrame ( )

Default TDataFrame constructor.

Definition at line 16 of file TRDataFrame.cxx.

◆ TRDataFrame() [2/4]

ROOT::R::TRDataFrame::TRDataFrame ( SEXP obj )

inline

TDataFrame constructor.

Parameters

obj	raw R object that can be casted to DataFrame

Definition at line 343 of file TRDataFrame.h.

◆ TRDataFrame() [3/4]

TRDataFrame::TRDataFrame ( const TRDataFrame & _df )

TDataFrame copy constructor.

Parameters

_df	other TRDataFrame

Definition at line 22 of file TRDataFrame.cxx.

◆ TRDataFrame() [4/4]

ROOT::R::TRDataFrame::TRDataFrame ( const Rcpp::DataFrame & _df )

inline

TDataFrame constructor for Rcpp::DataFrame.

Parameters

_df	raw dataframe from Rcpp

Definition at line 356 of file TRDataFrame.h.

Member Function Documentation

◆ AsMatrix()

template<class T >

TMatrixT< T > ROOT::R::TRDataFrame::AsMatrix ( )

inline

Method to get dataframe as matrix.

Note: only work on numerical dataframes if some column if string or other it will fail

Returns: TMatrixT with a given tamplate data type

Definition at line 417 of file TRDataFrame.h.

◆ Class()

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

static

Returns: TClass describing this class

◆ Class_Name()

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

static

Returns: Name of this class

◆ Class_Version()

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

inlinestaticconstexpr

Returns: Version of this class

Definition at line 437 of file TRDataFrame.h.

◆ DeclFileName()

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

inlinestatic

Returns: Name of the file containing the class declaration

Definition at line 437 of file TRDataFrame.h.

◆ GetColNames()

TVectorString ROOT::R::TRDataFrame::GetColNames ( )

inline

Method to get labels of dataframe.

Returns: columns names

Definition at line 404 of file TRDataFrame.h.

◆ GetNcols()

Int_t ROOT::R::TRDataFrame::GetNcols ( )

inline

Method to get the number of columns.

Returns: number of cols

Definition at line 394 of file TRDataFrame.h.

◆ GetNrows()

Int_t ROOT::R::TRDataFrame::GetNrows ( )

inline

Method to get the number of rows.

Returns: number of rows

Definition at line 399 of file TRDataFrame.h.

◆ IsA()

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

inlinevirtual

Returns: TClass describing current object

Reimplemented from TObject.

Definition at line 437 of file TRDataFrame.h.

◆ operator SEXP() [1/2]

ROOT::R::TRDataFrame::operator SEXP ( )

inline

Definition at line 380 of file TRDataFrame.h.

◆ operator SEXP() [2/2]

ROOT::R::TRDataFrame::operator SEXP ( ) const

inline

Definition at line 385 of file TRDataFrame.h.

◆ operator=() [1/3]

TRDataFrame & ROOT::R::TRDataFrame::operator= ( SEXP obj )

inline

Definition at line 374 of file TRDataFrame.h.

◆ operator=() [2/3]

TRDataFrame & ROOT::R::TRDataFrame::operator= ( TRDataFrame & obj )

inline

Definition at line 362 of file TRDataFrame.h.

◆ operator=() [3/3]

TRDataFrame & ROOT::R::TRDataFrame::operator= ( TRDataFrame obj )

inline

Definition at line 368 of file TRDataFrame.h.

◆ operator[]()

TRDataFrame::Binding TRDataFrame::operator[] ( const TString & name )

Definition at line 28 of file TRDataFrame.cxx.

◆ Print()

void ROOT::R::TRDataFrame::Print ( const Char_t * label = "" )

inline

Method to print the dataframe in stdout or a column given the label.

Parameters

label number of the column to print

Definition at line 427 of file TRDataFrame.h.

◆ Streamer()

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

virtual

Stream an object of class TObject.

Reimplemented from TObject.

◆ StreamerNVirtual()

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

inline

Definition at line 437 of file TRDataFrame.h.

Friends And Related Symbol Documentation

◆ Rcpp::wrap

SEXP Rcpp::wrap ( const TRDataFrame & f )

friend

◆ TRInterface

friend class TRInterface

friend

Definition at line 177 of file TRDataFrame.h.

Member Data Documentation

◆ df

Rcpp::DataFrame ROOT::R::TRDataFrame::df

protected

Definition at line 180 of file TRDataFrame.h.

Libraries for ROOT::R::TRDataFrame:

[legend]

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

bindings/r/inc/TRDataFrame.h
bindings/r/src/TRDataFrame.cxx

TRDataFrame class

Creating variables

Assigning values

Creating dataframe object with its labels

Passing dataframe to R's environment

Adding colunms to dataframe

Getting dataframe from R's environment

Working with colunms between dataframes

Working with colunms between dataframes

Users Guide

Classes

Public Member Functions

Static Public Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ TRDataFrame() [1/4]

◆ TRDataFrame() [2/4]

◆ TRDataFrame() [3/4]

◆ TRDataFrame() [4/4]

Member Function Documentation

◆ AsMatrix()

◆ Class()

◆ Class_Name()

◆ Class_Version()

◆ DeclFileName()

◆ GetColNames()

◆ GetNcols()

◆ GetNrows()

◆ IsA()

◆ operator SEXP() [1/2]

◆ operator SEXP() [2/2]

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ operator[]()

◆ Print()

◆ Streamer()

◆ StreamerNVirtual()

Friends And Related Symbol Documentation

◆ Rcpp::wrap

◆ TRInterface

Member Data Documentation

◆ df