readme.Rmd

---
output: github_document
---

<!-- badges: start -->

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/PolicyAnalysisInc/openqaly/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/PolicyAnalysisInc/openqaly/tree/master)
[![Codecov test coverage](https://codecov.io/gh/policyanalysisinc/openqaly/branch/master/graph/badge.svg)](https://app.codecov.io/gh/policyanalysisinc/openqaly?branch=master)
<!-- badges: end -->

# openqaly

A package for creating and running cost-effectiveness models.

## Installation

```{r, eval = FALSE}
# install.packages("pak")
pak::pak("PolicyAnalysisInc/openqaly")
```

## Quick example

```{r, eval = FALSE}
library(openqaly)

model <- define_model() |>
  add_strategy("treatment") |>
  add_state("healthy") |>
  add_state("dead") |>
  add_transition("healthy", "dead", 0.05) |>
  add_summary("cost", "healthy", 1000) |>
  add_summary("outcome", "healthy", 1)

results <- run_model(model)
```

## Learn more

- [Articles](articles/index.html) — tutorials, analysis guides, diagnostics
- [Function reference](reference/index.html) — full API by topic
- [Custom PSM tutorial](articles/custom_psm.html)
- [Setting up PSA](articles/psa_setup.html)
- [Decision trees](articles/decision_trees.html)


## Planned Features
- Supports PSM, Markov, Microsimulation, DES, Custom
- Multiple methods for specifying transition matrices
- Standardized model data format
- VBP/DSA/Scenario/PSA Analyses
- Parameter solving
- Arbitrary object parameters
- Sampling of tables & arbitrary object parameters (bootstrap, custom sampling, etc...)
- Custom model checks
- Embarassingly parallel archictecture
- Modular structure allowing models to be combined
- Comprehensive logging of model evaluation
- Decision-tree functionality
- Cleaner code