summary.cfbsimR_simulation.Rd

% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summary_cfbsimR.R
\name{summary.cfbsimR_simulation}
\alias{summary.cfbsimR_simulation}
\title{Compute Pretty Simulations Summary Table}
\usage{
\method{summary}{cfbsimR_simulation}(object, ...)
}
\arguments{
\item{object}{an object for which a summary is desired.}

\item{...}{additional arguments passed on to the methods (currently not used).}
}
\description{
Uses the R package gt to create a pretty html table of the
cfbsimR simulation summary data frame.
}
\section{Output of below example}{

\if{html}{\figure{summary_tbl.png}{options: width=75\%}}
}

\examples{
\donttest{
library(cfbsimR)
# set seed for recreation
set.seed(20220315)

# Simulate the season 20 times in 1 round
sim <- cfbsimR::simulate_cfb(
  cfb_season = 2022,
  fresh_season = TRUE,
  simulations = 20
)

# Create Summary Tables
tbl <- summary(sim)

# The output of tbl is given in the above image.
}
}