R/conversion.R

In rearrr: Rearranging Data

#' @title Conversion between radians and degrees
#' @description
#'  \Sexpr[results=rd, stage=render]{lifecycle::badge("experimental")}
#'
#'  Convert degrees to radians or radians to degrees.
#'
#' @author Ludvig Renbo Olsen, \email{r-pkgs@@ludvigolsen.dk}
#' @param degrees \code{vector} of degrees to convert to radians with \deqn{`degrees` * (\pi / 180)}
#' @param radians \code{vector} of radians to convert to degrees with \deqn{`radians` / (\pi / 180)}
#' @export
#' @return \code{vector} with converted degrees/radians.
#'
#'  Missing values (\code{NA}s) are returned as they are.
#' @examples
#' # Attach packages
#' library(rearrr)
#' library(dplyr)
#'
#' # Degrees to radians
#' degrees_to_radians(c(90, 180, 270))
#'
#' # Radians to degrees
#' radians_to_degrees(c(pi / 2, pi, 1.5 * pi))
#'
#' # Get back the original degrees
#' radians_to_degrees(degrees_to_radians(c(90, 180, 270)))
degrees_to_radians <- function(degrees) {
  checkmate::assert_numeric(degrees)
  degrees * (pi / 180)
}

#' @rdname degrees_to_radians
#' @export
radians_to_degrees <- function(radians) {
  checkmate::assert_numeric(radians)
  radians / (pi / 180)
}