report_performance_summary: report_performance_summary

View source: R/dCVnet_performance.R

report_performance_summaryR Documentation

report_performance_summary

Description

extracts performance from a dCVnet object calculates classification statistics and provides a summary of mean, sd, min, and max

Usage

report_performance_summary(
  dCVnet_object,
  short = FALSE,
  somersD = FALSE,
  pvprevalence = "observed"
)

Arguments

dCVnet_object

result from a call to dCVnet

short

(bool) return a core set of performance measures.

somersD

(bool) calculate the computationally expensive Somers' D for certain families (gaussian, poisson)

pvprevalence

allows calculation of PPV/NPV at different prevalences. set to "observed" to use the prevalence of the data. For binomial data use a single value, for multinomial use a named vector of prevalences with names as per the levels of y. Note: does not affect the presented prevalence value in the table.

Value

a data.frame of summarised and raw performance statistics.


AndrewLawrence/dCVnet documentation built on Sept. 24, 2024, 5:24 a.m.