Logo ROOT   master
Reference Guide
ROOT::R::TRDataFrame Class Reference


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


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");

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

Passing dataframe to R's environment


r["df1"]<<df1;
r<<"print(df1)";

Output

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

Manipulating data between dataframes

Adding colunms to dataframe


//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


r<<"df2<-data.frame(v1=c(0.1,0.2,0.3),v2=c(3,2,1))";
r["df2"]>>df2;
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

1 0.1 3 v1
2 0.2 2 v2
3 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
1 v1 0.101 1 v1 -1
2 v2 0.202 2 v2 -2
3 v3 0.303 3 v3 -3

Users Guide

http://oproject.org/tiki-index.php?page=ROOT+R+Users+Guide
https://root.cern.ch/drupal/content/how-use-r-root-root-r-interface

Definition at line 177 of file TRDataFrame.h.

Classes

class  Binding
 

Public Member Functions

 TRDataFrame ()
 
Default TDataFrame constructor More...
 
 TRDataFrame (SEXP obj)
 
TDataFrame constructor More...
 
 TRDataFrame (const TRDataFrame &_df)
 
TDataFrame copy constructor More...
 
 TRDataFrame (const Rcpp::DataFrame &_df)
 
TDataFrame constructor for Rcpp::DataFrame More...
 
template<class T >
TMatrixT< T > AsMatrix ()
 
Method to get dataframe as matrix More...
 
TVectorString GetColNames ()
 
Method to get labels of dataframe More...
 
Int_t GetNcols ()
 
Method to get the number of colunms More...
 
Int_t GetNrows ()
 
Method to get the number of rows More...
 
 operator SEXP ()
 
 operator SEXP () const
 
TRDataFrameoperator= (TRDataFrame &obj)
 
TRDataFrameoperator= (TRDataFrame obj)
 
TRDataFrameoperator= (SEXP 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 More...
 
- Public Member Functions inherited from TObject
 TObject ()
 TObject constructor. More...
 
 TObject (const TObject &object)
 TObject copy ctor. More...
 
virtual ~TObject ()
 TObject destructor. More...
 
void AbstractMethod (const char *method) const
 Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
 
virtual void AppendPad (Option_t *option="")
 Append graphics object to current pad. More...
 
virtual void Browse (TBrowser *b)
 Browse object. May be overridden for another default action. More...
 
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. More...
 
virtual const char * ClassName () const
 Returns name of class to which the object belongs. More...
 
virtual void Clear (Option_t *="")
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare abstract method. More...
 
virtual void Copy (TObject &object) const
 Copy this to obj. More...
 
virtual void Delete (Option_t *option="")
 Delete this object. More...
 
virtual Int_t DistancetoPrimitive (Int_t px, Int_t py)
 Computes distance from point (px,py) to the object. More...
 
virtual void Draw (Option_t *option="")
 Default Draw method for all objects. More...
 
virtual void DrawClass () const
 Draw class inheritance tree of the class to which this object belongs. More...
 
virtual TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). More...
 
virtual void Dump () const
 Dump contents of object on stdout. More...
 
virtual void Error (const char *method, const char *msgfmt,...) const
 Issue error message. More...
 
virtual void Execute (const char *method, const char *params, Int_t *error=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 Execute method on this object with parameters stored in the TObjArray. More...
 
virtual void ExecuteEvent (Int_t event, Int_t px, Int_t py)
 Execute action corresponding to an event at (px,py). More...
 
virtual void Fatal (const char *method, const char *msgfmt,...) const
 Issue fatal error message. More...
 
virtual TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () const
 Get option used by the graphics system to draw this object. More...
 
virtual const char * GetIconName () const
 Returns mime type name of object. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual char * GetObjectInfo (Int_t px, Int_t py) const
 Returns string containing info about the object at position (px,py). More...
 
virtual Option_tGetOption () const
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual UInt_t GetUniqueID () const
 Return the unique object id. More...
 
virtual Bool_t HandleTimer (TTimer *timer)
 Execute action in response of a timer timing out. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
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. More...
 
virtual void Info (const char *method, const char *msgfmt,...) const
 Issue info message. More...
 
virtual Bool_t InheritsFrom (const char *classname) const
 Returns kTRUE if object inherits from class "classname". More...
 
virtual Bool_t InheritsFrom (const TClass *cl) const
 Returns kTRUE if object inherits from TClass cl. More...
 
virtual void Inspect () const
 Dump contents of this object in a graphics canvas. More...
 
void InvertBit (UInt_t f)
 
virtual Bool_t IsEqual (const TObject *obj) const
 Default equal comparison (objects are equal if they have the same address in memory). More...
 
virtual Bool_t IsFolder () const
 Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
 
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. More...
 
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). More...
 
virtual Bool_t Notify ()
 This method must be overridden to handle object notification. More...
 
void Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
 Use this method to declare a method obsolete. More...
 
void operator delete (void *ptr)
 Operator delete. More...
 
void operator delete[] (void *ptr)
 Operator delete []. More...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (const TObject &rhs)
 TObject assignment operator. More...
 
virtual void Paint (Option_t *option="")
 This method must be overridden if a class wants to paint itself. More...
 
virtual void Pop ()
 Pop on object drawn in a pad to the top of the display list. More...
 
virtual void Print (Option_t *option="") const
 This method must be overridden when a class wants to print itself. More...
 
virtual Int_t Read (const char *name)
 Read contents of object with specified name from the current directory. More...
 
virtual void RecursiveRemove (TObject *obj)
 Recursively remove this object from a list. More...
 
void ResetBit (UInt_t f)
 
virtual void SaveAs (const char *filename="", Option_t *option="") const
 Save this object in the file specified by filename. More...
 
virtual void SavePrimitive (std::ostream &out, Option_t *option="")
 Save a primitive as a C++ statement(s) on output stream "out". More...
 
void SetBit (UInt_t f, Bool_t set)
 Set or unset the user status bits as specified in f. More...
 
void SetBit (UInt_t f)
 
virtual void SetDrawOption (Option_t *option="")
 Set drawing option for object. More...
 
virtual void SetUniqueID (UInt_t uid)
 Set the unique object id. More...
 
virtual void SysError (const char *method, const char *msgfmt,...) const
 Issue system error message. More...
 
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. More...
 
virtual void Warning (const char *method, const char *msgfmt,...) const
 Issue warning message. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
 Write this object to the current directory. More...
 

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 = BIT(0), kOverwrite = BIT(1), kWriteDelete = BIT(2) }
 
enum  EDeprecatedStatusBits { kObjInCanvas = BIT(3) }
 
enum  EStatusBits {
  kCanDelete = BIT(0), kMustCleanup = BIT(3), kIsReferenced = BIT(4), kHasUUID = BIT(5),
  kCannotPick = BIT(6), kNoContextMenu = BIT(8), kInvalidObject = BIT(13)
}
 
- Static Public Member Functions inherited from TObject
static Long_t GetDtorOnly ()
 Return destructor only flag. More...
 
static Bool_t GetObjectStat ()
 Get status of object stat flag. More...
 
static void SetDtorOnly (void *obj)
 Set destructor only flag. More...
 
static void SetObjectStat (Bool_t stat)
 Turn on/off tracking of objects in the TObjectTable. More...
 
- 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). More...
 
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 14 of file TRDataFrame.cxx.

◆ TRDataFrame() [2/4]

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


TDataFrame constructor

Parameters
objraw R object that can be casted to DataFrame

Definition at line 344 of file TRDataFrame.h.

◆ TRDataFrame() [3/4]

TRDataFrame::TRDataFrame ( const TRDataFrame _df)


TDataFrame copy constructor

Parameters
_dfother TRDataFrame

Definition at line 20 of file TRDataFrame.cxx.

◆ TRDataFrame() [4/4]

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


TDataFrame constructor for Rcpp::DataFrame

Parameters
_dfraw dataframe from Rcpp

Definition at line 357 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 418 of file TRDataFrame.h.

◆ GetColNames()

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


Method to get labels of dataframe

Returns
colunms names

Definition at line 405 of file TRDataFrame.h.

◆ GetNcols()

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


Method to get the number of colunms

Returns
number of cols

Definition at line 395 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 400 of file TRDataFrame.h.

◆ operator SEXP() [1/2]

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

Definition at line 381 of file TRDataFrame.h.

◆ operator SEXP() [2/2]

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

Definition at line 386 of file TRDataFrame.h.

◆ operator=() [1/3]

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

Definition at line 363 of file TRDataFrame.h.

◆ operator=() [2/3]

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

Definition at line 369 of file TRDataFrame.h.

◆ operator=() [3/3]

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

Definition at line 375 of file TRDataFrame.h.

◆ operator[]()

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

Definition at line 26 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
labelnomber of the column to print

Definition at line 428 of file TRDataFrame.h.

Friends And Related Function Documentation

◆ Rcpp::wrap

SEXP Rcpp::wrap ( const TRDataFrame f)
friend

◆ TRInterface

friend class TRInterface
friend

Definition at line 178 of file TRDataFrame.h.

Member Data Documentation

◆ df

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

Definition at line 181 of file TRDataFrame.h.

Libraries for ROOT::R::TRDataFrame:
[legend]

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