Learn R Programming

pmml (version 1.2.34)

pmml.randomForest: Generate PMML for a Random Forest (randomForest) object

Description

Generate the Predictive Model Markup Language (PMML) representation of a randomForest forest object. In particular, this function gives the user the ability to save the geometry of a forest as a PMML XML document.

Usage

## S3 method for class 'randomForest':
pmml(model, model.name="randomForest_Model",
     app.name="Rattle/PMML",
     description="Random Forest Tree Model",
     copyright = NULL,
     transforms = NULL, ...)

Arguments

model
the forest object contained in an object of class randomForest, as that contained in the object returned by the function randomForest.
model.name
a name to give to the model in the PMML.
app.name
the name of the application that generated the PMML.
description
a descriptive text for the header of the PMML.
copyright
the copyright notice for the model.
transforms
transforms to represent within the PMML.
...
further arguments passed to or from other methods.

Value

  • An object of class XMLNode as that defined by the XML package. This represents the top level, or root node, of the XML document and is of type PMML. It can be written to file with saveXML.

Details

The Predictive Model Markup Language is an XML based language which provides a way for applications to define statistical and data mining models and to share models between PMML compliant applications. More information about PMML and the Data Mining Group can be found at http://www.dmg.org.

Use of PMML and pmml.randomForest requires the XML package. Be aware that XML is a very verbose data format. Reasonably sized trees and data sets can lead to extremely large text files. XML, while achieving interoperability, is not an efficient data storage mechanism in this case.

This function is used to export the structure of the forest to other PMML compliant applications, including graphics packages that are capable of printing binary trees.

References

Breiman, L. (2001), /emph{Random Forests}, Machine Learning 45(1),5-32

PMML home page: http://www.dmg.org

A. Guazzelli, W. Lin, T. Jena (2012), /emph{PMML in Action: Unleashing the Power of Open Standards for Data Mining and Predictive Analytics}. CreativeSpace (Second Edition - Available on Amazon.com - http://www.amazon.com/dp/1470003244.

A. Guazzelli, M. Zeller, W. Lin, G. Williams (2009), /emph{PMML: An Open Standard for Sharing Models}. The R journal, Volume 1/1, 60-65

See Also

pmml.

Examples

Run this code
# Build a simple randomForest model

library(randomForest)
(iris.rf <- randomForest(Species ~ ., data=iris, ntree=2))

# Convert to pmml

pmml(iris.rf)

Run the code above in your browser using DataLab