R/Constants.R

In paulhendricks/functools: Tools for Functional Programming in R

#' Return the value TRUE.
#'
#' \code{True()} is a function that returns TRUE.
#'
#' @return TRUE.
#' @family constants
#' @examples
#' # True() returns TRUE:
#' True()
#' @export
True <- function() {
  return(TRUE)
}

#' Return the value FALSE.
#'
#' \code{False()} is a function that returns FALSE.
#'
#' @return FALSE.
#' @family constants
#' @examples
#' # False() returns FALSE:
#' False()
#' @export
False <- function() {
  return(FALSE)
}

#' Return the object passed to it.
#'
#' \code{Identity()} returns itself.
#'
#' @param .x an object.
#' @return the object.
#' @family constants
#' @examples
#' # Return itself:
#' Identity(5)
#' Identity(mean)
#' Identity(lm(data = mtcars, mpg ~ cyl))
#'
#' @export
Identity <- function(.x) {
  return(.x)
}

#' Return the value NULL.
#'
#' \code{Null()} is a function that returns NULL.
#'
#' @return NULL.
#' @family constants
#' @examples
#' # Null() returns NULL:
#' Null()
#'
#' @export
Null <- function() {
  return(NULL)
}

#' Return the value NA.
#'
#' \code{Na()} is a function that returns NA.
#'
#' @return NA.
#' @family constants
#' @examples
#' # Na() returns NA:
#' Na()
#' @export
Na <- function() {
  return(NA)
}