Switch to unified view

a b/man/CalculateDaysAtRisk-methods.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/eventData.R, R/singleSimDetails.R
3
\docType{methods}
4
\name{CalculateDaysAtRisk}
5
\alias{CalculateDaysAtRisk}
6
\alias{CalculateDaysAtRisk,EventData-method}
7
\alias{CalculateDaysAtRisk,SingleSimDetails-method}
8
\title{Calculate the number of days at risk}
9
\usage{
10
CalculateDaysAtRisk(object, ...)
11
12
\S4method{CalculateDaysAtRisk}{EventData}(object)
13
14
\S4method{CalculateDaysAtRisk}{SingleSimDetails}(object, times)
15
}
16
\arguments{
17
\item{object}{The object to calculate the days at risk}
18
19
\item{...}{Additional arguments passed to the function}
20
21
\item{times}{A vector of dates for calculating cutting the simulated date at in order to
22
calculate the number of days at risk by this point.}
23
}
24
\description{
25
For \code{EventData} object this is the number of days
26
at risk of the input data. For \code{SingleSimDetails} object
27
this is the median numberof days at risk in the simulation set at the given time
28
}
29