R/convert_distance.R

In scarecrow21/convertr: Convert Units of Measurement

#' Meter to Kilometer
#'
#' @param distance_meter Distance in meter
#'
#' @return Distance in kilometer
#' @export
#'
#' @examples
#' meter_to_kilometer(1000)
meter_to_kilometer <- function(distance_meter) {
  distance_kilometer <- distance_meter / 1000

  return (distance_kilometer)
}


#' Kilometer to Meter
#'
#' @param distance_kilometer Distance in kilometer
#'
#' @return Distance in meter
#' @export
#'
#' @examples
#' kilometer_to_meter(1)
kilometer_to_meter <- function(distance_kilometer) {
  distance_meter <- distance_kilometer * 1000

  return (distance_meter)
}


#' Meter to Centimeter
#'
#' @param distance_meter Distance in meter
#'
#' @return Distance in centimeter
#' @export
#'
#' @examples
#' meter_to_centimeter(1)
meter_to_centimeter <- function(distance_meter) {
  distance_centimeter <- distance_meter * 100

  return (distance_centimeter)
}



#' Centimeter to Meter
#'
#' @param distance_centimeter Distance in centimeter
#'
#' @return Distance in meter
#' @export
#'
#' @examples
#' centimeter_to_meter(100)
centimeter_to_meter <- function(distance_centimeter) {
  distance_meter <- distance_centimeter / 100

  return (distance_meter)
}


#' Convert Distance
#'
#' @param distance distance value
#' @param from convert from unit
#' @param to convert to unit
#'
#' @return distance
#' @export
#'
#' @examples
#' convert_distance(100, from="meter", to = "kilometer")
convert_distance <- function(distance, from, to) {
  if(from == "meter" && to == "kilometer") {
    meter_to_kilometer(distance)
  } else if (from == "kilometer" && to == "meter") {
    kilometer_to_meter(distance)
  } else if (from == "meter" && to == "centimeter") {
    meter_to_centimeter(distance)
  } else if (from == "centimeter" && to == "meter") {
    centimeter_to_meter(distance)
  } else {
    return("Incorrect distance units.")
  }
}