risk.summary {BCRA}R Documentation

List the records with relative risks and absolute risks

Description

A function to list all the records with relative risks and absolute risks.

Usage

risk.summary(data, Raw_Ind=1)

Arguments

data

A data set containing all the required input data needed to perform risk projections, such as initial age, projection age, BrCa relative risk covariates and race. See exampledata for details.

Raw_Ind

The raw file indicator with default value 1. Raw_Ind=1 means RR covariates are in raw/original format. Raw_Ind=0 means RR covariates have already been re-coded to 0, 1, 2 or 3.

Value

A data frame that includes age, duration of the projection time interval, covariates and the projected risk. A CSV file is created to save the data frame under user's working directory for reading convenience.

See Also

relative.risk, absolute.risk

Examples

data(exampledata)
risk.summary(exampledata)

[Package BCRA version 2.1.2 Index]