PReMiuM (version 3.1.3)

plotRiskProfile: Plot the Risk Profiles

Description

Plots the risk profiles for a profile regression model.

Usage

plotRiskProfile(riskProfObj, outFile, showRelativeRisk=F,  orderBy=NULL, whichClusters=NULL,  whichCovariates=NULL, useProfileStar=F,riskLim=NULL)

Arguments

riskProfObj

An object of type riskProfObj.

outFile

Path and file name to save the plot.

showRelativeRisk

Whether to show the relative risk (with respect to the risk of the first cluster). This option is not available for Normal outcome. For Survival outcomes it computed proportional hazards, but only if the option proportionalHazards=T was used in the function calcAvgRiskAndProfile().

orderBy

Order by which the clusters are to be displayed. It can take values "Empirical", "ClusterSize" and "Risk" (the latter only if the outcome is provided). It can also take the name of a covariate to order the clusters, in which case the clusters are ordered.

whichClusters

Either a vector of indeces that corresponds to the clusters that are to be displayed. The length of this vector must be greater than 1. The default is that all clusters are shown.

whichCovariates

Either a vector of indeces or a vector of strings that corresponds to the covariates that are to be displayed. The length of this vector must be greater than 1. The default is that all covariates are shown.

useProfileStar

To be set equal to TRUE only if a variable selection procedure has been run. The definition of the star profile is given in Liverani, S., Hastie, D. I. and Richardson, S. (2013) PReMiuM: An R package for Bayesian profile regression.

riskLim

Limits of the y-axis for the plot of the boxplots for the response variable. The default is NULL. If the riskLim are provided, they should be a vector of length 2.

Value

This function creates a png plot saved in the path given by outFile. All clusters are visually displayed together.For discrete covariates, instead of plotting the probability that a phi is above or below the mean value, we plot the actual phi values (and plot the mean value across clusters as a horizontal line).For normal covariates, for each covariate the upper plot is the posterior distribution for the mean mu, and the lower plot is the posterior distribution of sqrt(Sigma[j,j]) (i.e. the standard deviation for that covariate).It also returns the following vector.

meanSortIndex

This vector is the index that represents the order that the clusters are represented. The default ordering is by empirical risk.

Authors

David Hastie, Department of Epidemiology and Biostatistics, Imperial College London, UK Silvia Liverani, Department of Epidemiology and Biostatistics, Imperial College London and MRC Biostatistics Unit, Cambridge, UK Maintainer: Silvia Liverani

References

Silvia Liverani, David I. Hastie, Lamiae Azizi, Michail Papathomas, Sylvia Richardson (2015). PReMiuM: An R Package for Profile Regression Mixture Models Using Dirichlet Processes. Journal of Statistical Software, 64(7), 1-30. URL http://www.jstatsoft.org/v64/i07/.

Examples

## Not run: 
# # example for Poisson outcome and Discrete covariates
# inputs <- generateSampleDataFile(clusSummaryPoissonDiscrete())
# runInfoObj<-profRegr(yModel=inputs$yModel, 
#     xModel=inputs$xModel, nSweeps=10, nClusInit=15,
#     nBurn=20, data=inputs$inputData, output="output", 
#     covNames = inputs$covNames, outcomeT = inputs$outcomeT,
#     fixedEffectsNames = inputs$fixedEffectNames)
# 
# dissimObj<-calcDissimilarityMatrix(runInfoObj)
# clusObj<-calcOptimalClustering(dissimObj)
# riskProfileObj<-calcAvgRiskAndProfile(clusObj)
# clusterOrderObj<-plotRiskProfile(riskProfileObj,"summary.png")
# ## End(Not run)