make_comparison: make an interactive histogram of rate ratios, or a...

View source: R/viz.R

make_comparisonR Documentation

make an interactive histogram of rate ratios, or a scatterplot for rate comparisons, between two areas

Description

make an interactive histogram of rate ratios, or a scatterplot for rate comparisons, between two areas

Usage

make_comparison(
  MSA1 = "Baton Rouge, LA",
  MSA2 = "Tucson, AZ",
  logscale = TRUE,
  type = "scatter",
  min.rate = 10,
  rate_table
)

Arguments

MSA1

character(1) element of column 'MSA' that must be present in 'rate_table'

MSA2

character(1) element of column 'MSA' that must be present in 'rate_table'

logscale

logical(1) only for type "scatter"; if TRUE (default) log10 transformation is applied to rates

type

character(1) one of "scatter" or "ratios"; if the latter, a histogram of ratios is produced with MSA1 rates in numerator

min.rate

numeric(1) minimum number per 100000 for cancer type to be included

rate_table

data.frame like 'woncan' in YESCDS or BiocYES

Examples

data(woncan)
make_comparison(type="scatter", rate_table=woncan)
make_comparison(type="ratios", rate_table=woncan)

vjcitn/YESCDS documentation built on April 16, 2024, 1:03 p.m.