Extend examples and see also of sprintf_format function

R/format_value.R

@@ -121,12 +121,36 @@ check_aligns <- function(algn) {
 #'   string \code{format}.
 #' @seealso \code{\link[base]{sprintf}}
 #'
+#'  \code{\link[formatters]{round_fmt}}
+#'
+#'  \code{\link[formatters]{list_formats}}
+#'
 #' @examples
 #' fmtfun <- sprintf_format("(N=%i")
 #' format_value(100, format = fmtfun)
 #'
 #' fmtfun2 <- sprintf_format("%.4f - %.2f")
 #' format_value(list(12.23456, 2.724))
+#'
+#' # You can also customise rtables values
+#' fmtfun3 <- sprintf_format("this range => %.1f")
+#' format_value(100, format = fmtfun3)
+#'
+#' fmtfun4 <- sprintf_format("sadbasd asa a %.2f asda a %.1f")
+#' format_value(list(12.23456, 2.724), format = fmtfun4)
+#' \dontrun{
+#' require(rtable)
+#' lyt <- basic_table() %>%
+#'   split_cols_by("Species") %>%
+#'   analyze("Sepal.Length", afun = function(x) {
+#'     list(
+#'       "mean (sd)" = rcell(c(mean(x), sd(x)), format = fmtfun4),
+#'       "range" = rcell(diff(range(x)), format = fmtfun3)
+#'     )
+#'   })
+#' build_table(lyt, iris)
+#' }
+#'
 sprintf_format <- function(format) {
   function(x, ...) {
     do.call(sprintf, c(list(fmt = format), x))