Skip to content

Commit

Permalink
updated documenation
Browse files Browse the repository at this point in the history
  • Loading branch information
mzayeddfe committed Oct 4, 2024
1 parent 6f38c67 commit 9753670
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions R/pretty.R
Original file line number Diff line number Diff line change
Expand Up @@ -209,14 +209,15 @@ pretty_time_taken <- function(start_time, end_time) {
#'
#' # Applied over an example vector
#' vector <- c(3998098008, -123421421, "c", "x")
#' unlist(lapply(vector, pretty_num))
#' unlist(lapply(vector, pretty_num, prefix = "+/-", gbp = TRUE))
#' pretty_num(vector)
#' pretty_num(vector, prefix = "+/-", gbp = TRUE)
#'
#' # Return original values if NA
#' unlist(lapply(vector, pretty_num, ignore_na = TRUE))
#' pretty_num(vector,ignore_na = TRUE)
#'
#' # Return alternative value in place of NA
#' unlist(lapply(vector, pretty_num, alt_na = "z"))
#' pretty_num(vector, alt_na = "z")

pretty_num <- function(

Check warning on line 221 in R/pretty.R

View workflow job for this annotation

GitHub Actions / lint

file=R/pretty.R,line=221,col=1,[cyclocomp_linter] Functions should have cyclomatic complexity of less than 15, this has 16.
value,
prefix = "",
Expand Down

0 comments on commit 9753670

Please sign in to comment.