added f_month

DESCRIPTION

@@ -9,7 +9,7 @@ Description: Format numbers for publication; includes the removal of
         p-value formatter.
 Depends: R (>= 3.2.0)
 Suggests: testthat
-Date: 2016-10-12
+Date: 2016-12-19
 License: GPL-2
 LazyData: TRUE
 Roxygen: list(wrap = FALSE)

NAMESPACE

@@ -5,7 +5,9 @@ export(f_bills)
 export(f_comma)
 export(f_dollar)
 export(f_mills)
+export(f_month)
 export(f_num)
+export(f_number2month)
 export(f_ordinal)
 export(f_percent)
 export(f_prefix)

R/f_affix.R

@@ -5,10 +5,9 @@
 #' @param x A vector of elements to append with an affix.
 #' @param prefix A string to append to the front of elements.
 #' @param suffix A string to append to the back of elements.
-#' @return
+#' @return Returns a string of affix appended digits.
 #' @export
 #' @rdname f_affix
-#' @seealso
 #' @examples
 #' f_affix(1:5, "-", "%")
 #' f_affix(f_num(1:5, 2), "-", "%")

R/f_month.R

@@ -0,0 +1,25 @@
+#' Format Months to One Letter Abbreviation
+#'
+#' Format long month name or integer formats to a single capital letter.  Useful
+#' for plot scales as a way to save space.  \code{f_month} is used for
+#' nominal data where as  \code{f_number2month} is reserved for integers
+#' 1-12.
+#'
+#' @param x A vector of month names or integers 1-12.
+#' @return Returns a single letter month abbreviation atomic vector.
+#' @export
+#' @rdname f_month
+#' @examples
+#' f_month(month.name)
+#' f_number2month(1:12)
+f_month <- function(x) {
+    toupper(gsub("(^.)(.+)", "\\1", as.character(x)))
+}
+
+
+#' @export
+#' @rdname f_month
+f_number2month <- function(x) {
+    toupper(gsub("(^.)(.+)", "\\1", month.abb[x]))
+}
+