summaryDB: A graphical summary of the database content.

Description Usage Arguments Value Examples

View source: R/summaryDB.R

Description

Given an object of class comorbidity, and the characters used to specify the sex, a figure containing 3 plots, one of the age distribution, another one of the age distribution and the third one with the relation between age and sex distribution.

Usage

1
2
3
summaryDB(input, maleCode = "Male", femaleCode = "Female",
  barColor = "darkblue", femaleColor = "gold",
  maleColor = "lightblue", verbose = FALSE, warnings = TRUE)

Arguments

input

Object of comorbidity class.

maleCode

Characters(s) used to determine the male condition of a patient. Depending on the database it can be determined, for example, as Male, . MALE, M, with digits as 0 or 1.

femaleCode

Characters(s) used to determine the female condition of a patient. Depending on the database it can be determined, for example, as Female, . FEMALE, F, with digits as 0 or 1.

barColor

Determines the bar color. By default darkblue.

femaleColor

Determines the color for female values. By default gold.

maleColor

Determines the color for male values. By default lightblue.

verbose

By default FALSE. Change it to TRUE to get a on-time log from the function.

warnings

By default TRUE. Change it to FALSE to don't see the warnings.

Value

A multiple graph containing a barplot with age distribution, a boxplot representing age distribution by sex and a pie chart representing sex distribution.

Examples

1
2
3
4
5
load(system.file("extdata", "comorbidity.RData", package="comoRbidity"))
summaryDB( input      = comor_obj, 
           maleCode   = "Male", 
           femaleCode = "Female"
           )

aGutierrezSacristan/comorbidity documentation built on April 10, 2020, 5:54 p.m.