R/foo.R

In data-science-competitions/IEEE-CIS-Fraud-Detection: R Project Template for Analytic Applications such as Machine Learning Competitions

# foo --------------------------------------------------------------------------
#
#' @title Compose a Message with an Entity Name and Age
#'
#' @description Given \code{name} and \code{age}, when \code{foo} is
#'   called, then a string with that entity details is composed and returned.
#'
#' @param name (`character`) The name of the entity.
#' @param age (`numeric`) The age of the entity.
#'
#' @return (`character`) A string with the entity's details.
#' @export
#'
#' @examples
#' \dontrun{
#' msg <- foo('Earth', 4.543e9)
#' message(msg)
#' }
#'
foo <- function(name, age){
    .assert_is_a_non_missing_nor_empty_string(name)
    .assert_is_positive_and_finite(age)

    age <- format(age, scientific = FALSE)
    msg <- paste(name, 'is', age, 'years old')

    return(msg)
}