skeleton: The Main Skeleton Build Function

In mlhutchins/fast-analytics: Fast Prototyping of Analysis Scripts

Description

Generate R analysis scripts prefilled with database queries, data processing, plotting functions, and plot saving. When finished either source the .R file, set the function to source it automatically, or edit the plotting functions for the specific details of the analysis.

Usage

skeleton(filename = "analysis.R", csid, plots, run = FALSE,
  username = NULL, tex = FALSE)

Arguments

filename	The resulting name of the .R script
csid	The CSID(s) to process in the script
plots	List of plots to include
run	Whether to source the resulting analysis script, defaults to FALSE
username	Database username, password defaults to a .pgpass password (highly recommended)
tex	TRUE to compile a Beamer presentation of the generated figures, defaults to FALSE

Details

A total list of available plot functions arein the See Also section under other skeletonPlots.

Plot functions passed to skeleton need to take no input and output a list of named character vectors for data, plot, etc.

Value

Writes the analysis script of csid to make plots to the file filename

See Also

Other skeletonPlots: batteryTimeSeries, downloadTimeSeries, lteNoiseTimeSeries, ltePowerTimeSeries, temperatureTimeSeries, timeSeries, uploadTimeSeries; boxPlot, dataspeedBoxPlot, downloadAccessBoxPlot, downloadTTFBBoxPlot, downloadTaskBoxPlot, emailAccessBoxPlot, emailTaskBoxPlot, ldrAccessBoxPlot, ldrTaskBoxPlot, lteNoiseBoxPlot, ltePowerBoxPlot, uploadAccessBoxPlot, uploadTaskBoxPlot; callFailureBarChart; callFailureMap, m2mFailureMap, twilioFailureMap; cdfPlot, udpDropCDF, udpDropSizeCDF, udpLatencyCDF, udpLatencySizeCDF; downloadSuccessPlot, emailSuccessPlot, ldrSuccessPlot, successPlot, uploadSuccessPlot; execRootscores; networkTechnologyBar; plotUnitTest; rootscoreBarChart

Examples

## Make a few basic plots for a scout of Edimburgh and run resulting script
skeleton("edinburgh", 3138,
         list(downloadTimeSeries, uploadTimeSeries,
              downloadBoxPlot, uploadBoxPlot,
              twilioFailureMap, m2mFailureMap), run = TRUE)

## Make a full report of Edinburgh and compile it
skeleton("edinburgh", 3138,
         plotUnitTest(), run = TRUE, tex = TRUE)

mlhutchins/fast-analytics documentation built on May 23, 2019, 2:10 a.m.