README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```
# gfoRmula: Parametric G-Formula

<!-- badges: start -->
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/gfoRmula)](https://cran.r-project.org/package=gfoRmula)
[![R-CMD-check](https://github.com/CausalInference/gfoRmula/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/CausalInference/gfoRmula/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/CausalInference/gfoRmula/graph/badge.svg)](https://app.codecov.io/gh/CausalInference/gfoRmula)
<!-- badges: end -->

## Installation

You can install the released version of `gfoRmula` from CRAN with:

``` r
install.packages("gfoRmula")
```

After installing the `devtools` package (i.e., calling `install.packages(devtools)`), the development version of `gfoRmula` can be installed from GitHub with:
``` r
devtools::install_github("CausalInference/gfoRmula")
```

## Usage

Please refer to [McGrath et al. (2020)](https://doi.org/10.1016/j.patter.2020.100008) for a detailed guide to the `gfoRmula` package. Also, see the following vignettes regarding updates since McGrath et al. (2020):

* "A Simplified Approach for Specifying Interventions in gfoRmula"
* "Using Custom Outcome Models in gfoRmula"