R/percent.R

Defines functions calculatePercentDifference getPercent getPercentageIncrase getPercentageDecrase

Documented in calculatePercentDifference getPercent getPercentageDecrase getPercentageIncrase

#' A percent of B
#'
#' Calculate How Much Percent A of B is
#' @param a Number One
#' @param b Number Two
#' @keywords percent
#' @export
#' @examples
#' calculatePercentDifferencece(1,2)
calculatePercentDifference <- function(a,b) {
  return(a/b)
}
#' x\% of Number is how much
#'
#' Calculate How Much Percent A\% of B is
#' @param percent Number One (Percentage)
#' @param number Number Two
#' @keywords percent
#' @export
#' @examples
#' getPercent(12,434)
getPercent <- function(percent,number) {
  return((number/100)*percent)
}
#' Calculate Percentage Incrase
#'
#' Calculate Percentage Incrase between 2 Numbers
#' @param lower Number One
#' @param higher Number Two
#' @keywords percent
#' @export
#' @examples
#' percentageIncrase(100,110)
getPercentageIncrase <- function(lower,higher) {
  #Increase ÷ Original Number × 100.
  return(((higher-lower)/lower))
}
#' Calculate Percentage Decrase
#'
#' Calculate Percentage Incrase between 2 Numbers
#' @param lower Number One
#' @param higher Number Two
#' @keywords percent
#' @export
#' @examples
#' percentageDecrase(100,110)
getPercentageDecrase <- function(lower,higher) {
  #Decrase ÷ Original Number × 100.
  return(((lower-higher)/lower))
}
maxmayr95/STWIBFH documentation built on Dec. 31, 2019, 12:56 a.m.