From 2409698336fd00bd2cc6d0c8792fee130b393ba4 Mon Sep 17 00:00:00 2001
From: "Matthew B. Kaufmann" <57465744+mbkauf@users.noreply.github.com>
Date: Wed, 2 Sep 2026 09:28:41 -0500
Subject: [PATCH] update documentation

---
 NAMESPACE           |  1 +
 README.md           |  4 ++++
 man/owsa_tornado.Rd | 27 ++++++++++++++++++---------
 man/print.icers.Rd  | 25 +++++++++++++++++++++++++
 4 files changed, 48 insertions(+), 9 deletions(-)
 create mode 100644 man/print.icers.Rd

diff --git a/NAMESPACE b/NAMESPACE
index f8477c1..de74cd4 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -10,6 +10,7 @@ S3method(plot,owsa)
 S3method(plot,psa)
 S3method(plot,twsa)
 S3method(predict,metamodel)
+S3method(print,icers)
 S3method(print,metamodel)
 S3method(print,sa)
 S3method(summary,ceac)
diff --git a/README.md b/README.md
index bf6d9da..f4de193 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,10 @@
 # dampack
 <!-- [![Build Status](https://www.travis-ci.com/DARTH-git/dampack.svg?branch=master)](https://www.travis-ci.com/DARTH-git/dampack) -->
 
+<!-- badges: start -->
+  [![R-CMD-check](https://github.com/DARTH-git/dampack/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/DARTH-git/dampack/actions/workflows/R-CMD-check.yaml)
+  <!-- badges: end -->
+  
 The Decision Analytic Modeling Package (dampack) is a suite of functions for analyzing and visualizing the health economic outputs of mathematical models. 
 
 Created and maintained by Fernando Alarid-Escudero ([@feralaes](https://github.com/feralaes)), Greg Knowlton ([@gknowlt](https://github.com/gknowlt)), and Eva Enns ([@evaenns](https://github.com/evaenns)), and important contributions from David Garibay ([@dugartre](https://github.com/dugartre)), and Mark Clements ([@mclements](https://github.com/mclements)).
diff --git a/man/owsa_tornado.Rd b/man/owsa_tornado.Rd
index 9992c96..00472a8 100644
--- a/man/owsa_tornado.Rd
+++ b/man/owsa_tornado.Rd
@@ -12,30 +12,39 @@ owsa_tornado(
   col = c("full", "bw"),
   n_y_ticks = 8,
   ylim = NULL,
-  ybreaks = NULL
+  ybreaks = NULL,
+  select_str = NULL,
+  outcome_name = NULL
 )
 }
 \arguments{
 \item{owsa}{an owsa object}
 
-\item{return}{either return a ggplot object \code{plot} or a data frame with
-ranges of parameters for which each strategy is optimal.}
+\item{return}{choose whether to return the plot, underlying data, or both}
 
-\item{txtsize}{base text size}
+\item{txtsize}{text size used for the plot; input for add_common_aes function}
 
 \item{min_rel_diff}{this function only plots
 parameters that lead to a relative change in the outcome greater than or equal
 to \code{min_rel_diff}, which must be between 0 and 1. The default (0) is that
 no strategies are filtered.}
 
-\item{col}{either none, full color, or black and white}
+\item{col}{color used for the plot; input for add_common_aes function}
 
-\item{n_y_ticks}{number of y-axis ticks}
+\item{n_y_ticks}{number of y-axis ticks; input for add_common_aes function}
 
-\item{ylim}{vector of y-axis limits, or NULL, which sets limits automatically}
+\item{ylim}{vector of y-axis limits, or NULL, which sets limits
+automatically; input for add_common_aes function}
 
-\item{ybreaks}{vector of y-axis breaks.
-will override \code{n_y_ticks} if provided.}
+\item{ybreaks}{vector of y-axis breaks, will override \code{n_y_ticks} if
+provided; input for add_common_aes function}
+
+\item{select_str}{vector of strategy names to examine (max of 2). If none are
+input, it will default to choose only the first of the strategies in the owsa
+object.}
+
+\item{outcome_name}{The name of the outcome to show by strategy, either IMB,
+NMB, or ICER}
 }
 \value{
 If \code{return == "plot"}, a \code{ggplot2} tornado plot derived from the \code{owsa}
diff --git a/man/print.icers.Rd b/man/print.icers.Rd
new file mode 100644
index 0000000..4011d03
--- /dev/null
+++ b/man/print.icers.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/icers.R
+\name{print.icers}
+\alias{print.icers}
+\title{Print the formatted CEA table}
+\usage{
+\method{print}{icers}(x, currency = "$", dig_cost = 0, dig_eff = 2, dig_icer = 0)
+}
+\arguments{
+\item{x}{Object of class \code{icers}}
+
+\item{currency}{string. with currency used in the cost-effectiveness analysis (CEA).}
+
+\item{dig_cost}{integer. number of digits to round costs to}
+
+\item{dig_eff}{integer. number of digits to round effects to}
+
+\item{dig_icer}{integer. number of digits to round ICER to}
+}
+\value{
+a dataframe object - formatted CEA table
+}
+\description{
+Print the formatted CEA table
+}