otvPlots (version 0.2.1)

SummaryStats: Create summary statistics for a numerical variable

Description

Create summary statistics for a numerical variable

Usage

SummaryStats(myVar, dataFl, dateGp, weightNm = NULL)

Arguments

myVar

The name of the variable to be plotted

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.

weightNm

Name of the variable containing row weights, or NULL for no weights (all rows receiving weight 1).

Value

meltdx

A data.table for use by the plotting funtions PlotMean, PlotQuantiles, and PlotRates.

numVarSummary

A data.table of summary statistics.

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.

Examples

# NOT RUN {
data(bankData)
bankData <- PrepData(bankData, dateNm = "date", dateGp = "quarters", 
                    dateGpBp = "years")
mdx <- SummaryStats(myVar = "age", dataFl = bankData, 
                   dateGp = "quarters")$meltdx
plot(PlotQuantiles(mdx[variable %in% c("p99", "p50", "p1", "p99_g", "p50_g",
                   "p1_g")], "age", "quarters"))
plot(PlotMean(mdx[variable %in% c("mean", "cl1", "cl2")], "age", "quarters"))
plot(PlotRates(mdx, "age", "quarters"))
# }