From 4fc977ea84555f603d57b6e651d7724cf8f98ade Mon Sep 17 00:00:00 2001 From: ZAYED Date: Wed, 16 Oct 2024 12:29:39 +0100 Subject: [PATCH] updated documentation and readme --- DESCRIPTION | 2 +- NEWS.md | 4 ++++ R/pretty.R | 3 ++- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 1c2c847..3f1d2d4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Type: Package Package: dfeR Title: Common DfE R tasks -Version: 0.6.0 +Version: 0.6.1 Authors@R: c( person("Cam", "Race", , "cameron.race@education.gov.uk", role = c("aut", "cre")), person("Laura", "Selby", , "laura.selby@education.gov.uk", role = "aut"), diff --git a/NEWS.md b/NEWS.md index bc8c200..dca7aaa 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# dfeR 0.6.1 + +Patch to update the pretty_num() function so that the `dp` argument's default is 0. + # dfeR 0.6.0 Update pretty_num so that: diff --git a/R/pretty.R b/R/pretty.R index efaeba3..3136a90 100644 --- a/R/pretty.R +++ b/R/pretty.R @@ -190,7 +190,8 @@ pretty_time_taken <- function(start_time, end_time) { #' @param alt_na alternative value to return in place of NA, e.g. "x" #' @param nsmall minimum number of digits to the right of the decimal point. #' If NULL, the value of `dp` will be used. -#' If value of `dp` is less than 0, then `nsmall` will automatically be set to 0. +#' If the value of `dp` is less than 0, then `nsmall` will +#' automatically be set to 0. #' #' @return string featuring prettified value #' @family prettying