pmml (version 1.5.5)

pmml.coxph: Generate PMML for coxph objects

Description

Generate the PMML representation for a coxph object from package survival.

Usage

# S3 method for coxph
pmml(model, model.name="CoxPH_Survival_Regression_Model",
    app.name="Rattle/PMML", 
    description="CoxPH Survival Regression Model", 
    copyright=NULL, transforms=NULL, unknownValue=NULL, …)

Arguments

model

a coxph object.

model.name

a name to be given to the model in the PMML code.

app.name

the name of the application that generated the PMML code.

description

a descriptive text for the Header element of the PMML code.

copyright

the copyright notice for the model.

transforms

data transformations represented in PMML via pmmlTransformations.

unknownValue

value to be used as the 'missingValueReplacement' attribute for all MiningFields.

further arguments passed to or from other methods.

Details

A coxph object is the result of fitting a proportional hazards regression model, using the "coxph" function from the package survival. Although the survival package supports special terms "cluster", "tt" and "strata", only the special term "strata" is supported by the pmml package. Note that special term "strata" cannot be a multiplicative variable and only numeric risk regression is supported.

References

R project CRAN package: survival: Survival Analysis https://CRAN.R-project.org/package=survival