Creates a template for a prediction journal paper with the characteristics/results filled in
createPlpJournalDocument(
plpResult = NULL,
plpValidation = NULL,
plpData = NULL,
targetName = "",
outcomeName = "",
table1 = F,
connectionDetails = NULL,
includeTrain = FALSE,
includeTest = TRUE,
includePredictionPicture = TRUE,
includeAttritionPlot = TRUE,
outputLocation = file.path(getwd(), "plp_journal_document.docx"),
save = T
) An object of type plpResult returned by running runPlp()
An object of type validatePlp returned by running externalValidatePlp()
The plpData
A string with the target description name
A string with the outcome description name
Whether to include table1 (characteristics)
The connection required to calcualte the characteristics
Whether to include the train set performance
Whether to include the test set performance
Whether to include a picture detailing the prediction problem
Whether to include the attriction plot
The location to write the document to
If false this fucntion returns the document and does not save to outputLocation
A work document containing the selected outputs within the user's directory at location specified in outputLocation
The function creates a word document containing the analysis details, data summary and prediction model results.