transportPlp: Transports a plpResult to a new location and removed...

Description Usage Arguments Details Examples

View source: R/ImportExport.R

Description

Transports a plpResult to a new location and removed sensitive data

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
transportPlp(
  plpResult,
  modelName = NULL,
  dataName = NULL,
  outputFolder,
  n = NULL,
  includeEvaluationStatistics = T,
  includeThresholdSummary = T,
  includeDemographicSummary = T,
  includeCalibrationSummary = T,
  includePredictionDistribution = T,
  includeCovariateSummary = T,
  save = T
)

Arguments

plpResult

An object returned by running runPlp.

modelName

A string of the name of the model

dataName

A string of the name of the data

outputFolder

The folder on the file system where the CSV files will be created. If the folder does not yet exist it will be created.

n

The minimum number of people required for each result summary to be included

includeEvaluationStatistics

Whether to include the evaluationStatistics

includeThresholdSummary

Whether to include the thresholdSummary

includeDemographicSummary

Whether to include the demographicSummary

includeCalibrationSummary

Whether to include the calibrationSummary

includePredictionDistribution

Whether to include the predictionDistribution

includeCovariateSummary

Whether to include the covariateSummary

save

Whether to save the result or just return the transportable object

Details

This function is used to

Examples

1
2
3
4
## Not run: 
transportPlp(plpResult, "s:/temp/exportTest", n=10)

## End(Not run)

hxia/plp-git-demo documentation built on March 19, 2021, 1:54 a.m.