Learn R Programming

gfoRmula: Parametric G-Formula

Installation

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

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:

devtools::install_github("CausalInference/gfoRmula")

Usage

Please refer to McGrath et al. (2020) 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”

Copy Link

Version

Install

install.packages('gfoRmula')

Monthly Downloads

624

Version

1.1.1

License

GPL-3

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/CausalInference/gfoRmula

Homepage

https://doi.org/10.1016/j.patter.2020.100008

Maintainer

Sean McGrath

Last Published

March 24th, 2025

Functions in gfoRmula (1.1.1)

Get Plotting Information

Estimation of Survival Outcome, Continuous End-of-Follow-Up Outcome, or Binary End-of-Follow-Up Outcome Under the Parametric G-Formula

fit_zeroinfl_normal

Fit Zero-Inflated Normal Model on Covariate

gformula_binary_eof

Estimation of Binary End-of-Follow-Up Outcome Under the Parametric G-Formula

Get Covariate Plots

Get Risk and Survival Plots

fit_trunc_normal

Fit Truncated Normal Model on Covariate

fit_multinomial

Fit Multinomial Model on Covariate

fit_bounded_continuous

Fit Bounded Normal Model on Covariate

Fit GLM on Covariate

plot.gformula_continuous_eof

Plot method for objects of class "gformula_continuous_eof"

Calculate Observed Covariate Means and Risk

gformula_continuous_eof

Estimation of Continuous End-of-Follow-Up Outcome Under the Parametric G-Formula

plot.gformula_binary_eof

Plot method for objects of class "gformula_binary_eof"

gformula_survival

Estimation of Survival Outcome Under the Parametric G-Formula

History functions

Format Simulated Dataset for Hazard Ratio Calculation

Execute Intervention

Natural Course Intervention

Generates Functions of History of Existing Covariates

Calculate RMSE for Covariate, Outcome, and Competing Risk Models

Fit Outcome Model

predict_binomial

Simulate Binary Values

predict_trunc_normal

Simulate Truncated Normal Values

print.gformula_survival

Print and summary methods for "gformula" objects

plot.gformula_survival

Plot method for objects of class "gformula_survival"

Fit Competing Event Model

Create Visit Sum Covariate

Simulate Normal Values

Variance-covariance method for objects of class "gformula"

Threshold Intervention

simple_restriction

Simple Restriction

Fit Covariate Models

Static Intervention

Simulate Counterfactual Outcomes Under Intervention

Example Dataset for a Survival Outcome with Censoring

Coefficient method for objects of class "gformula"

Example Dataset for a Survival Outcome with an Indicator of Censoring Variable

bootstrap_helper

Bootstrap Observed Data and Simulate Under All Interventions

Example Dataset for a Binary Outcome at End of Follow-Up

basicdata_nocomp

Example Dataset for a Survival Outcome without Censoring

continuous_eofdata

Example Dataset for a Continuous Outcome at End of Follow-Up

continuous_eofdata_pb

Example Dataset for a Continuous Outcome at End of Follow-Up with Pre-Baseline Times

General Error Catching