mod: ~~function to do ... ~~

Description Usage Arguments Details Value Note Author(s) References See Also Examples

View source: R/quaddisc.R

Description

~~ A concise (1-5 lines) description of what the function does. ~~

Usage

1
mod(dX, dY)

Arguments

dX

~~Describe dX here~~

dY

~~Describe dY here~~

Details

~~ If necessary, more details than the description above ~~

Value

~Describe the value returned If it is a LIST, use

comp1

Description of 'comp1'

comp2

Description of 'comp2'

...

Note

~~further notes~~

~Make other sections like Warning with Warning .... ~

Author(s)

~~who you are~~

References

~put references to the literature/web site here ~

See Also

~~objects to See Also as help, ~~~

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
##---- Should be DIRECTLY executable !! ----
##-- ==>  Define data, use random,
##--	or do  help(data=index)  for the standard data sets.

## The function is currently defined as
function (dX, dY) 
{
    if (dY == 0) 
        return("Error: second argument must be != 0 in function mod")
    else {
        iResult <- dX%%dY
        if (iResult < 0) 
            iResult <- iResult + abs(dY)
        return(iResult)
    }
  }

quaddisc documentation built on May 2, 2019, 4:50 p.m.