R/rutilsMH.r

In haddonm/rutilsMH: DEPRECATED. USE codeutils AND hplot INSTEAD. Contains utility functions commonly used when writing R code.

#' rutilsMH: a set of functions to assist with code development
#'
#' The rutilsMH package provides an array of utility functions:
#' these include documentation functions and summary functions
#'
#' @section codeutils:
#' \describe{
#'   \item{countgtOne}{counts values >1 in a vector}
#'   \item{countgtzero}{counts values >0 in a vector}
#'   \item{countNAs}{count the numbr of NA values in a vector}
#'   \item{countones}{count the number of values = 1 in a vector}
#'   \item{countzeros}{count the number of values = 0 in a vector}
#'   \item{codeBlock}{generates a comment section ready to copy into code}
#'   \item{classDF}{Tabulates the class of each column in a dataframe}
#'   \item{getname}{returns the name of a variable as character}
#'   \item{properties}{characterizes properties of data.frame columns}
#' }
#' @section fileutils:
#' \describe{
#'   \item{listFunctions}{lists all functions in a given R file}
#'   \item{classDF}{identifies the class of each column in a data.frame}
#' }
#' @section plotutils:
#' \describe{
#'   \item{newplot}{bare-bones plotprep, opens a new device + default par}
#'   \item{parsyn}{prints par command syntax to the console to be copied}
#'   \item{plotprep}{sets up a plotting device external to Rstudio}
#'   \item{setplot}{writes a base graphics template to the console}
#' }
#' @section rmdutils:
#' \describe{
#'   \item{lininterpol}{linearly replaces NA values in a vector}
#'   \item{greplow}{a case ignoring 'grep'}
#'   \item{printV}{prints a vector as a column with index numbers}
#'   \item{quants}{used in apply to estimate quantiles across a vector}
#'   \item{which.closest}{finds closest value in a vector to a given number}
#' }
#' @section diagrams:
#' \describe{
#'   \item{canvas}{sets up a plotting area ready for use}
#'   \item{circle}{draws a circle with a given origin and radius}
#' }
#' 
#' @docType package
#' @name rutilsMH
NULL

#' @importFrom grDevices dev.cur dev.new dev.off png palette
#' @importFrom graphics par grid plot axis mtext polygon title hist lines text
#' @importFrom graphics points
#' @importFrom utils tail head str write.table write.csv
#' @importFrom stats quantile loess sd 
#' @importFrom knitr kable
NULL