|
a |
|
b/man/plot.Rd |
|
|
1 |
% Generated by roxygen2: do not edit by hand |
|
|
2 |
% Please edit documentation in R/s3_generics.R |
|
|
3 |
\name{plot} |
|
|
4 |
\alias{plot} |
|
|
5 |
\alias{plot.accrual} |
|
|
6 |
\alias{plot.trial_structure} |
|
|
7 |
\title{Plot method for an object of class \code{accrual}. Creates |
|
|
8 |
a line plot of cumulative recruitment, grouped by trial arm, |
|
|
9 |
using ggplot2.} |
|
|
10 |
\arguments{ |
|
|
11 |
\item{accrual_obj}{Object of class \code{accrual}.} |
|
|
12 |
|
|
|
13 |
\item{plot_prefix}{Prefix for file name to identify plot type. |
|
|
14 |
Defaults to \code{accrual_plot}.} |
|
|
15 |
|
|
|
16 |
\item{run_time}{Specify a particular instance of \code{biomkrAccrual()} |
|
|
17 |
execution using a date-time format \code{yyyy-mm-dd-hh-mm-ss}.} |
|
|
18 |
|
|
|
19 |
\item{output_path}{= Directory where the output files from the |
|
|
20 |
\code{biomkrAccrual()} instance are located.} |
|
|
21 |
|
|
|
22 |
\item{figs_path}{Folder where figures generated during execution |
|
|
23 |
will be stored; defaults to the \code{figures} subdirectory in |
|
|
24 |
\code{output_path}.} |
|
|
25 |
|
|
|
26 |
\item{x}{An object of class \code{trial_structure}.} |
|
|
27 |
} |
|
|
28 |
\description{ |
|
|
29 |
Plot method for an object of class \code{accrual}. Creates |
|
|
30 |
a line plot of cumulative recruitment, grouped by trial arm, |
|
|
31 |
using ggplot2. |
|
|
32 |
|
|
|
33 |
Prints initial trial structure as a matrix of prevalences by recruitment |
|
|
34 |
and experimental arms. |
|
|
35 |
} |