summary.fhcrc: Summarise simulation results

In mclements/prostata: Prostate Cancer Microsimulation for Sweden

Summarise simulation results

Description

FUNCTION_DESCRIPTION

Calculates the difference between two summary.fhcrc objects.

Calculates the results per a number of persons of a summary.fhcrc object.

Calculates the results divided by a denominator summary.fhcrc object.

Usage

## S3 method for class 'fhcrc'
summary(object, from = 0, ...)

## S3 method for class 'summary.fhcrc'
object1 - object2

## S3 method for class 'summary.fhcrc'
obj * perpersons

## S3 method for class 'summary.fhcrc'
obj / denominator

Arguments

object	PARAM_DESCRIPTION
from	Age from which to report
...	PARAM_DESCRIPTION
object1	The positive reference summary.fhcrc object.
object2	The negative summary.fhcrc object which is subtracted from object1.
obj	The summary.fhcrc object.
perpersons	a scalar to multiply the summary results with.
denominator	a scalar to divide the summary results with.

Details

DETAILS

Calculates the difference between two summary.fhcrc objects, e.g. the difference in life expectancy, quality of life etc. The exceptions are discountRate.costs and discountRate.effectiveness which are required two be the same for the two scenarios and the original value is returned. If n has the same value the original value is returned if they differ a list with both is returned.

N.b. this is unfortunatly not a commutative operator. Therefor the first parameter must be the summary.fhcrc object and the second parameter a nummeric scalar.

N.b. this is unfortunatly not a commutative operator. Therefor the first parameter must be the summary.fhcrc object and the second parameter a nummeric scalar.

Value

OUTPUT_DESCRIPTION

A summary.fhcrc object representing the difference between the two compared summary.fhcrc.

A summary.fhcrc object scaled for a number of persons.

A summary.fhcrc object scaled by a denominator.

Examples

## Not run: 
if(interactive()){
 #EXAMPLE1
 }

## End(Not run)
## Not run: 
if(interactive()){
 scenario1 <- summary(callFhcrc(screen = "screenUptake"))
 scenario2 <-summary(callFhcrc(screen = "noScreening"))
 scenario1 - scenario2
 }

## End(Not run)
## Not run: 
if(interactive()){
 ## Example 1
 scenario1 <- summary(callFhcrc(screen = "screenUptake"))
 scenario1 * 1000 # the summery per thousand persons

 ## Example 2
 scenario2 <-summary(callFhcrc(screen = "noScreening"))
 (scenario1 - scenario2) * 1000 # the difference per thousand persons
 }

## End(Not run)
## Not run: 
if(interactive()){
 }

## End(Not run)

mclements/prostata documentation built on Feb. 1, 2023, 1:20 p.m.