v2.5.2

pmml 2.5.2

Breaking Changes

• Removed support for RandomForestSRC package.

v2.5.1

pmml 2.5.1

Bug Fixes

• Fixed tests failing on CRAN Package Check Issue Kinds (M1mac and noLD) after release of 2.5.0.

Other Changes

• eval_metric is now explicitly set in xgboost tests to avoid warning messages.

v2.5.0

pmml 2.5.0

New Features

• pmml() now has a model_version parameter that can be used to add a modelVersion attribute to the PMML Header.
• xform_function() now supports "numeric" and "factor" new_field_data_type.

Bug Fixes

• save_pmml() no longer has the version parameter, since r-pmml exports PMML compliant with only the latest schema.

pmml v2.4.0

pmml 2.4.0

Breaking Changes

• pmml.ARIMA() no longer exports models with the Exact Least Squares method. Exports where ts_type = "arima" produce PMML with Conditional Least Squares representation only. The deprecated exact_least_squares parameter has been removed.
• pmml.ARIMA() now exports models with StateSpaceModel representation by default.

Major Changes

• Package now exports PMML with schema version 4.4.1.

Bug Fixes

• xform_function() no longer creates an unnecessary "NA" level in field_data$dataType.
• xform_wrap() no longer sets field_data$dataType to factor for all columns of a tibble.

v2.3.1

pmml 2.3.1

Bug Fixes

• pmml.xgb.Booster() no longer switches probabilities for "binary:logistic" objective function.
• add_data_field_attributes() now throws appropriate errors instead of using print() statements.

v2.3.0

pmml 2.3.0

New Features

• pmml.ARIMA() can now export models with StateSpaceModel representation. This is controlled by a new parameter, ts_type. The default option (ts_type = "arima") still exports an ARIMA representation as before. When ts_type = "statespace", the exported PMML uses a StateSpaceModel element.
• The exact_least_squares parameter in pmml.ARIMA() is now deprecated. In a future release, all exports where ts_type = "arima" will be exported with the Exact Least Squares method.

Other Changes

• Package is now compliant with the stringsAsFactors change in R 4.0.0.

v2.2.0

pmml 2.2.0

Breaking Changes

• Deprecated parameters in the following functions have been removed, and replaced with equivalent in snake case.
  • pmml.iForest: anomalyThreshold -> anomaly_threshold
  • pmml.kmeans: algorithm.name -> algorithm_name
  • rename_wrap_var: wrap_data -> wrap_object
  • xform_norm_discrete: inputVar -> input_var

New Features

• pmml.ARIMA() now exports prediction intervals for non-seasonal models.
• pmml.ARIMA() can now export seasonal models with Exact Least Squares representation, and does so by default.

v2.1.0

pmml 2.1.0

Major Changes

• Package now exports PMML with schema version 4.4.

• pmml.ARIMA() function added - exports ARIMA time series models from the forecast package with conditional least squares forecasting.

Breaking Changes

• pmml.svm() now has a detect_anomaly argument, allowing the user to specify whether the PMML detects anomalies or inliers. The exported PMML now has two OutputField elements: anomalyScore and one of anomaly or inlier.

• The following arguments are deprecated. They can still be used, but will produce a warning message and will be removed in a future release.

  • pmml.iForest: anomalyThreshold -> anomaly_threshold
  • pmml.kmeans: algorithm.name -> algorithm_name
  • rename_wrap_var: wrap_data -> wrap_object
  • xform_norm_discrete: inputVar -> input_var

Other Changes

• Application version in PMML Header corresponds to pmml package version.

• pmml.iForest now uses attribute sampleDataSize instead of element ParameterList to store the model$phi value.

• pmml.gbm now adds modelName attribute to the final segment for multinomial gbm models.

• testthat file names correspond to the functions being tested.

• Edited make_output_nodes doc for clarity.

• Updated formatting in vignettes.

• Fixed spelling and added word list via spelling package.

pmml 2.0.0

pmml 2.0.0

With this release, pmmlTransformations has been merged into pmml and package development has been moved to GitHub. This was also a good opportunity to apply a style and rename many functions and parameters to make the code more uniform and easier to understand.

Breaking Changes

We used the tidyverse style guide when renaming functions, parameters, and arguments. In addition, some parameters and arguments have been renamed for clarity, and several functions were removed.

For functions that use a dots (...) parameter, the old parameters will still be accepted, even though these old parameters will not be used.

• pmml() parameters and default arguments have been changed as follows:

  • model.name = "Rattle_Model" -> model_name = "R_Model"
  • app.name = "Rattle/PMML" -> app_name = "SoftwareAG PMML Generator"
  • unknownValue -> missing_value_replacement

• Individual exporters had the following changes:

  • pmml.iForest()
    • parentInvalidValueTreatment -> parent_invalid_value_treatment
    • childInvalidValueTreatment -> child_invalid_value_treatment
  • pmml.lm()
    • The unused dataset argument has been removed.
  • pmml.naiveBayes()
    • predictedField - predicted_field
  • pmml.randomForest()
    • unknownValue -> missing_value_replacement
    • parentInvalidValueTreatment -> parent_invalid_value_treatment
    • childInvalidValueTreatment -> child_invalid_value_treatment
  • pmml.xgb.Booster()
    • inputFeatureNames -> input_feature_names
    • outputLabelName -> output_label_name
    • outputCategories -> output_categories
    • xgbDumpFile -> xgb_dump_file
    • parentInvalidValueTreatment -> parent_invalid_value_treatment
    • childInvalidValueTreatment -> child_invalid_value_treatment

• The following additional functions had name and parameter changes:

  • AddAttributes() -> add_attributes()
    • xmlmodel -> xml_model
  • addDDAttributes() -> add_data_field_attributes()
  • addDFChildren() -> add_data_field_children()
  • addMSAttributes() -> add_mining_field_attributes()
xmlmodel -> xml_model
  • addOutputField() -> add_output_field()
    • xmlmodel -> xml_model
  • makeIntervals() -> make_intervals()
  • makeOutputNodes() -> make_output_nodes()
  • makeValues() -> make_values()

• Functions from pmmlTransformations have been merged into pmml and had the following name and parameter changes:

  • All functions had the following parameters renamed where present:
    • xformInfo -> xform_info
    • boxdata -> wrap_object (except in RenameVar)
    • mapMissingTo -> map_missing_to
  • DiscretizeXform() -> xform_discretize()
    • defaultValue -> default_value
    • mapMissingTo -> map_missing_to
  • FunctionXform() -> xform_function()
    • origFieldName -> orig_field_name
    • newFieldName -> new_field_name
    • newFieldDataType -> new_field_data_type
    • formulaText -> expression
  • MapXform() -> xform_map()
    • defaultValue -> default_value
  • MinMaxXform() -> xform_min_max()
  • NormDiscreteXform() -> xform_norm_discrete()
  • RenameVar() -> rename_wrap_var()
    • boxdata -> wrap_data
  • WrapData() -> xform_wrap()
    • indata -> data
    • useMatrix -> use_matrix
  • ZScoreXform() -> xform_z_score()

Deleted/moved functions

• The following functions have been removed from the package:

  • pmmltoc() - empty function.
  • addLT() - unused function.
  • pmmlCanExport() - unused function.
  • pmml.survreg() - untested exporter that may be added in the future.

• Initialize() has been made internal.

Other Changes

• All documentation is created with roxygen.

• Documentation is now uniform across different exporters.