R/mod.R

Defines functions mod

Documented in mod

#' @title Calculate the modulus of two numbers
#' 
#' @description Calculates the modulus of two numbers using the equation
#' z = x-y*floor(x/y)
#' 
#' @param x - a number or vector
#' @param y - a number or vector
#' 
#' @return the result x modulo y
#'
#'@export
#'
mod<-function(x,y) {
    z<-x-y*floor(x/y);
    return(z);
}
wStockhausen/wtsUtilities documentation built on Aug. 12, 2018, 7:01 a.m.