R/plotpdf.R

In gofMC: Goodness of Fit Noise Analysis Using Monte Carlo Techniques

##############################################################################################################################
#
# Plot the probability density function for a given number of degrees of freedom and noise distribution function
#
#
#' Plot PDF
#'
#' Plots the Probability Density Function
#'
#' @param dof an integer
#' @param order a real number
#' @param dist a random number distribution function
#' @param fitmetric a character string naming a standard fit metric (R2, rmse, or user)
#' @param ... any argument that functions within this routine might use
#'
#' @return ggplot object
#'
#' @examples
#' plotpdf(5, dist=runif, fitmetric=rmse)
#'
#' @export
#' plotpdf()
plotpdf <- function(dof, order=5, dist=rnorm, fitmetric=R2, ...){


dfx <- pcdfs(dof=dof, order=order, dist=dist, fitmetric=fitmetric, ...)

#see http://stackoverflow.com/questions/9439256/how-can-i-handle-r-cmd-check-no-visible-binding-for-global-variable-notes-when.  Need this to eliminate a note during R CMD check
pdf <- NULL
Nsam <- floor(10^order)
cdst <- deparse(substitute(dist))
cfit <- deparse(substitute(fitmetric))
dfxpdf <- dfx$pdf
dfxfitval <- dfx$fitval
mxy  <- max(dfx$pdf)
maxx <- max(dfx$fitval)
plot <- ggplot() + 
		geom_point(aes(dfxfitval, dfxpdf),size=1) +
		ylim(0,mxy) +
		xlab(cfit) + 
		ylab("Probability Density") +
		ggtitle(paste(cfit, "Probability Density Function"))

plot <- plot +
		annotate("text",x=0.95*maxx,y=0.9*mxy,label=paste("Noise Distribution:",cdst,
													"\nDegrees of Freedom:",dof,
													"\nNumber of  Samples:",Nsam),
													size=3,hjust=1,fontface=2)

return(plot)
}