Skip to content

metrumresearchgroup/pmforest

Repository files navigation


pmforest

Build Status

Installation

You can install the latest released version of pmforest via MPN snapshots from any snapshot date in March 2022 or later.

You can install the latest development version from GitHub with:

# install.packages("devtools")
devtools::install_github("metrumresearchgroup/pmforest", ref = "main")

Documentation

You can find documentation and a “Getting Started” vignette that shows users how to set up and summarize their data, as well as demonstrates the basic plotting methods. Additional formatting attributes are highlighted as well.

Featured Vignettes

  • Getting Started – Data specifications, summarization, and basic plotting methods.
  • Multiple Simulations – Plotting additional confidence intervals over the ‘replicate’ or simulation run.

Development

pmforest uses pkgr to manage development dependencies and renv to provide isolation. To replicate this environment,

  1. clone the repo

  2. install pkgr

  3. open package in an R session and run renv::init()

    • install renv > 0.8.3-4 into default .libPaths() if not already installed
  4. run pkgr install in terminal within package directory

  5. restart session

Then, launch R with the repo as the working directory (open the project in RStudio). renv will activate and find the project library.