describe_forest: Create a descriptive table of the results.

Description Usage Arguments Value Examples

View source: R/describe_forest.R

Description

describe_forest Generates a table of descriptives after stratifying the data into cost-effectiveness certainty groups after CEA forests.

Usage

1
2
3
4
5
6
7
8
describe_forest(
  forest,
  X = NULL,
  WTP = NULL,
  alpha = 0.05,
  certainty_groups = FALSE,
  ...
)

Arguments

forest

A trained CEA forest.

X

A matrix of variables to include in the table. If NULL, the X matrix from the forest object is used.

WTP

The willingness to pay threshold. Defaults to WTP supplied to CEA forest object. Ignored when certainty_groups is TRUE.

alpha

The desired significance level. Defaults to 0.05. Only used when certainty_groups is TRUE.

certainty_groups

Divide the sample into groups based on sampling uncertainty? Defaults to FALSE.

...

Other options to be passed to tableone::CreateTableOne (e.g., which variables are to be treated as factors, see examples).

Value

Returns a table object from the tableone package. See the print function from the tableone package for additional options.

Examples

1
2
3
4
## Not run: 
To be added...

## End(Not run)

bonander/CEAforests documentation built on April 1, 2021, 10:57 a.m.