add f_sign

trinker · Nov 18, 2016 · 05a3070 · 05a3070
1 parent 6481d7b
commit 05a3070
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 1 deletion.
diff --git a/NAMESPACE b/NAMESPACE
@@ -11,5 +11,6 @@ export(f_percent)
 export(f_prefix)
 export(f_prop2percent)
 export(f_pval)
+export(f_sign)
 export(f_suffix)
 export(f_thous)
diff --git a/R/f_sign.R b/R/f_sign.R
@@ -0,0 +1,19 @@
+#' Format Numeric Signs
+#'
+#' \code{f_sign} - Formats numeric values to just their sign
+#' ('-' == < 0, '+' == > 0, or '' == 0).
+#'
+#' @param x A vector of values.
+#' @param \ldots ignored.
+#' @return Returns a string of signs.
+#' @export
+#' @rdname f_sign
+#' @seealso \code{\link[numform]{f_num}}
+#' @examples
+#' f_sign(c(-10, 0, 10))
+f_sign <- function(x, ...) {
+
+    gsub("[01]", "", gsub("^1$", "+", as.character(sign(x))))
+
+}
+
diff --git a/man/f_sign.Rd b/man/f_sign.Rd
diff --git a/man/number_abbreviation.Rd b/man/number_abbreviation.Rd