Merge pull request #465 from jread-usgs/camelCase

camelCase changes per #464

Author: Lindsay Carr

NAMESPACE

@@ -37,7 +37,7 @@ export(is.gsplot)
 export(legend)
 export(lim)
 export(lines)
-export(loadConfig)
+export(load_config)
 export(logged)
 export(mtext)
 export(par)
@@ -52,8 +52,8 @@ export(theme.packers)
 export(title)
 export(view)
 export(view_info)
-export(whatDate)
-export(whatVersion)
+export(what_date)
+export(what_version)
 export(xlab)
 export(xlim)
 export(ylab)

R/access-gsplot.R

@@ -267,7 +267,7 @@ view_info <- function(object){
 #' @param object a gsplot object
 #' @return The date the gsplot object was created.
 #' @export
-whatDate <- function(object){
+what_date <- function(object){
   date_created <- object$metadata$created
   return(date_created)
 }
@@ -279,7 +279,7 @@ whatDate <- function(object){
 #' @param object a gsplot object
 #' @return The gsplot version number.
 #' @export
-whatVersion <- function(object){
+what_version <- function(object){
   version_created <- object$metadata$gsplot.version
   return(version_created)
 }

R/axis.R

@@ -69,6 +69,7 @@ axis <- function(object, ...) {
 #' @param tcl.minor tick length for minor ticks (used if \code{n.minor} > 0). Use NA (the default) to have this 
 #' calculated automatically as half of the value for \code{par('tcl')} at the time of rendering the axis. 
 #' @param reverse flip the orientation of the axis?
+#' @rdname axis
 #' @param append replace or append an existing axis for this side (logical)
 axis.gsplot <- function(object, ..., n.minor=0, tcl.minor=NA, reverse=NULL, append=FALSE) {
 

R/config.R

@@ -21,13 +21,13 @@ clear_par <- function(){
 #' @param filename string to custom file 
 #'
 #'@examples
-#'loadConfig()
+#'load_config()
 #'@export
 #' @importFrom graphics plot.xy
 #' @importFrom grDevices dev.off
 #' @importFrom graphics par
 #' @importFrom yaml yaml.load_file
-loadConfig = function(filename) {
+load_config = function(filename) {
 
   if(missing(filename)){
     filename <- system.file("extdata", "default.yaml", package = "gsplot")
@@ -84,7 +84,7 @@ config <- function(type, ..., persist=FALSE, custom.config = FALSE){
   type <- match.arg(type, choices = allowedTypes)
 
   if (is.null(gsconfig$options)) {
-    loadConfig()
+    load_config()
   }
 
   if(custom.config){

R/gsplot-class.R

@@ -9,7 +9,7 @@
 #' object. Defaults to calling \code{packageDescription()}. Output class matches that of the input.
 #' @param config.file path to the file that will only be used for setting 
 #' par in this one gsplot object. If \code{NA} (default), par is set by the global options set by
-#' loadConfig().
+#' load_config().
 #' @param theme There are several built in themes (see \link{Themes}). Additionally, the user can create a \code{gsplot}
 #' object in their workspace. This argument then takes the name of that object (either built-in or custom).
 #' If \code{NA} (default), no theme is used.

inst/doc/gsplotIntro.html

@@ -69,7 +69,7 @@
 
 <h1 class="title toc-ignore">Introduction to gsplot.</h1>
 <h4 class="author"><em>Jordan Read, Laura DeCicco, Jordan Walker, Phethala Thongsavanh, Lindsay Carr</em></h4>
-<h4 class="date"><em>22 March, 2017</em></h4>
+<h4 class="date"><em>24 March, 2017</em></h4>
 
 
 <div id="TOC">