R/grid.maker.r

In floswald/gridR: gridR: create different scalings of uniformly spaced grids.

#' grid maker 
#'
#' @description produce differently scaled one-dimensional grids
#' @param bounds numeric vector of length 2: bounds of interval
#' @param num.points number of points desired
#' @param spacing character vector indicating the desired spacing rule. Currently one of \code{\link{expo}}, \code{\link{expo2}}, \code{\link{hyp.sine}}, \code{\link{log.grid}}, \code{\link{gumbel.grid}}, \code{\link{lognorm.grid}} or \code{\link{beta.grid}}
#' @param plotit boolean TRUE if want a plot of result
#' @param ... additional arguments needed for grid.makers using distributions
#' @export
#' @return numeric vector of class "gridR" with attribute "spacing"
#' @examples
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="log.g",plotit=FALSE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="log.g",plotit=TRUE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="log.g2",plotit=TRUE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="log.g2",plotit=FALSE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="hyp.sine",plotit=FALSE)
#' grid.maker(bounds=c(-10,10),num.points=20,spacing="hyp.sine",plotit=TRUE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="exp.grid",plotit=TRUE)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="exp.grid",plotit=FALSE)
#' grid.maker(bounds=c(1,5),num.points=10,spacing="lognorm.grid",plotit=TRUE,meanlog=3,sdlog=0.5)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="lognorm.grid",plotit=FALSE,meanlog=3,sdlog=0.5)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="gumbel.grid",plotit=TRUE,loc=1,scale=1.1)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="gumbel.grid",plotit=FALSE,loc=1,scale=1.1)
#' grid.maker(bounds=c(-1,50),num.points=10,spacing="gumbel.grid",plotit=TRUE,loc=1,scale=10)
#' grid.maker(bounds=c(-1,50),num.points=10,spacing="gumbel.grid",plotit=TRUE,loc=10,scale=10)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="beta.grid",plotit=TRUE,shape1=2,shape2=5,ncp=0)
#' grid.maker(bounds=c(-10,5),num.points=20,spacing="beta.grid",plotit=TRUE,shape1=0.5,shape2=0.5,ncp=0)
#' grid.maker(bounds=c(-10,5),num.points=20,spacing="beta.grid",plotit=TRUE,shape1=0.5,shape2=1,ncp=0)
#' grid.maker(bounds=c(-10,5),num.points=20,spacing="beta.grid",plotit=TRUE,shape1=0.5,shape2=1,ncp=2)
#' grid.maker(bounds=c(-1,5),num.points=10,spacing="beta.grid",plotit=FALSE,shape1=2,shape2=5,ncp=1)
grid.maker <- function(bounds,num.points,spacing="log.g",plotit=FALSE,...){

	if (!is.character(spacing)) stop("spacing must be a character specifying the rule you want")
	stopifnot(length(bounds)==2)
	b <- sort(bounds)
	n <- num.points

	# apply transformation

	if (spacing=="log.g"){

		z <- log.g(b,n,plotit)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else if (spacing=="log.g2"){

		z <- log.g2(b,n,plotit)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else if (spacing=="hyp.sine"){

		z <- hyp.sine(b,n,plotit)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else if (spacing=="exp.grid"){

		z <- exp.grid(b,n,plotit)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else if (spacing=="gumbel.grid"){

		z <- gumbel.grid(b,n,plotit,...)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else if (spacing=="lognorm.grid"){

		z <- lognorm.grid(b,n,plotit,...)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)
	
	} else if (spacing=="beta.grid"){

		z <- beta.grid(b,n,plotit,...)
		class(z) <- "gridR"
		attr(z,"spacing") <- spacing
		return(z)

	} else {
		warning('you chose a rule that does not exist. 
			make sure you chose one of 
			log.g, log.g2, hyp.sine, exp.grid, gumbel.grid, lognorm.grid or beta.grid')
		return(NULL)
	}
}