pfa: Generate PFA Document from Object

In aurelius: Generates PFA Documents from R Code and Optionally Runs Them

Description

pfa is a generic function for generating valid PFA documents from the results of various model fitting functions. The function invokes particular methods which depend on the class of the first argument.

Usage

pfa(object, name = NULL, version = NULL, doc = NULL, metadata = NULL,
  randseed = NULL, options = NULL, ...)

Arguments

object	a model object for which a PFA document is desired
name	a character which is an optional name for the scoring engine
version	an integer which is sequential version number for the model
doc	a character which is documentation string for archival purposes
metadata	a list of strings that is computer-readable documentation for archival purposes
randseed	a integer which is a global seed used to generate all random numbers. Multiple scoring engines derived from the same PFA file have different seeds generated from the global one
options	a list with value types depending on option name Initialization or runtime options to customize implementation (e.g. optimization switches). May be overridden or ignored by PFA consumer
...	additional arguments affecting the PFA produced

Value

a list of lists that compose a valid PFA document

See Also

pfa.lm pfa.glm

Examples

# all the "pfa" methods found
methods("pfa")

Example output

 [1] pfa.Arima*        pfa.HoltWinters*  pfa.cv.glmnet*    pfa.ets*         
 [5] pfa.forecast*     pfa.gbm*          pfa.glm*          pfa.glmnet*      
 [9] pfa.ipredknn*     pfa.kcca*         pfa.kccasimple*   pfa.kmeans*      
[13] pfa.knn3*         pfa.knnreg*       pfa.lda*          pfa.lm*          
[17] pfa.naiveBayes*   pfa.randomForest* pfa.rpart*       
see '?methods' for accessing help and source code

aurelius documentation built on May 2, 2019, 3:43 a.m.