[d9ee58]: / man / plot.accrualplotdata.Rd

Download this file

53 lines (43 with data), 1.7 kB

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utils-graphics.R
\name{plot.accrualplotdata}
\alias{plot.accrualplotdata}
\title{S3 method to plot predicted recruitment from a long format
dataframe of class "accrualplotdata".}
\usage{
\method{plot}{accrualplotdata}(
data,
plot_prefix = "accrual_plot",
run_time = NULL,
output_path = "../biomkrAccrual_output_data/",
figs_path = paste0(output_path, "figures/"),
target_arm_size = NA_integer_,
target_control = NA_integer_,
target_interim = NA_integer_,
accrual_period = NA_integer_,
interim_period = NA_integer_
)
}
\arguments{
\item{data}{long format dataframe with columns "Week",
"Arm" and "Recruitment".}
\item{plot_prefix}{Prefix for file name to identify plot type.
Defaults to \code{accrual_plot}.}
\item{run_time}{Specify a particular instance of \code{biomkrAccrual()}
execution using a date-time format \code{yyyy-mm-dd-hh-mm-ss}.}
\item{output_path}{= Directory where the output files from the
\code{biomkrAccrual()} instance are located.}
\item{figs_path}{Folder where figures generated during execution
will be stored; defaults to the \code{figures} subdirectory in
\code{output_path}.}
\item{target_arm_size}{Number of subjects required for each treatment arm.}
\item{target_control}{Number of subjects required for control arm(s).}
\item{target_interim}{Number of subjects required for treatment arm at
interim analysis.}
\item{accrual_period}{Number of weeks in recruitment period.}
\item{interim_period}{Number of weeks to recruit for interim analysis.}
}
\description{
S3 method to plot predicted recruitment from a long format
dataframe of class "accrualplotdata".
}