PlotRatesOverTime: Creates trace plots of categories' proportions over time for...

In capitalone/otvPlots: Over Time Variable Plots

Creates trace plots of categories' proportions over time for a discrete (or binary) variable

Description

Creates trace plots of categories' proportions over time for a discrete (or binary) variable

Usage

PlotRatesOverTime(dataFl, dateGp, myVar, normBy = "time", weightNm = NULL,
  newLevels = NULL, kCategories = 9)

Arguments

dataFl	A data.table of data; must be the output of the PrepData function.
dateGp	Name of the variable that the time series plots should be grouped by. Options are NULL, "weeks", "months", "quarters", "years". See IDate for details. If NULL, then dateNm will be used as dateGp.
myVar	The name of the variable to be plotted
normBy	The normalization factor for rate plots, can be "time" or "var". If "time", then for each time period of dateGp, counts are normalized by the total counts over all categories in that time period. This illustrates changes of categories' proportions over time. If "var", then for each category, its counts are normalized by the total counts over time from only this category. This illustrates changes of categories' volumes over time.
weightNm	Name of the variable containing row weights, or NULL for no weights (all rows receiving weight 1).
newLevels	categories of myVar in order of global frequency
kCategories	If a categorical variable has more than kCategories, trace plots of only the kCategories most prevalent categories are plotted.

Value

A list:

p	ggplot object, trace plots of categories' proportions myVar over time.
catVarSummary	A data.table, contains categories' proportions globally, and over-time in each time period in dateGp. Each row is a category of the categorical (or binary) variable myVar. The row whose category == 'NA' corresponds to missing. Categories are ordered by global prevalence in a descending order.

License

Copyright 2017 Capital One Services, LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

See Also

Functions depend on this function: PlotCatVar.

This function depends on: PrepData.

Examples

data(bankData)
bankData$weight = rpois(nrow(bankData), 5)
bankData <- PrepData(bankData, dateNm = "date", dateGp = "months", 
                     dateGpBp = "quarters", weightNm = "weight")
PlotRatesOverTime(dataFl = bankData, dateGp = "months", weightNm = "weight",
                  myVar = "job", newLevels = NULL, normBy = "time")

capitalone/otvPlots documentation built on March 15, 2024, 8:25 a.m.