Switch to unified view

a b/man/DiagnosticPlot-methods.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/eventDataDiagnostic.R
3
\docType{methods}
4
\name{DiagnosticPlot}
5
\alias{DiagnosticPlot}
6
\alias{DiagnosticPlot,EventData-method}
7
\title{Output a plot showing the lag between censoring and the date the analysis
8
is being performed}
9
\usage{
10
DiagnosticPlot(object, ...)
11
12
\S4method{DiagnosticPlot}{EventData}(object, window.size = NULL,
13
  analysis.date = NULL, separate.events = TRUE)
14
}
15
\arguments{
16
\item{object}{An \code{EventData} object}
17
18
\item{...}{Additional arguments for the function}
19
20
\item{window.size}{An optional integer. If used an additional 2 lines at y=x-window.size 
21
and y = x-2*window.size are drawn on the graph. If \code{window.size} is chosen to be the
22
visit schedule (in days) then these lines provide an easy way to determine the number of subjects
23
who have missed one or two visits.}
24
25
\item{analysis.date}{The date the analysis is being perfomed on, by default (i.e. when NULL) it is the
26
the latest date at which any subject is censored/is known to have had an event}
27
28
\item{separate.events}{Logical, if FALSE then all events are coloured the same with label "Had Event", if
29
TRUE then the different event types (object@subject.data$event.type) are coloured individually.}
30
}
31
\description{
32
Output a plot showing the lag between censoring and the date the analysis
33
is being performed
34
}
35