relatives {biology}R Documentation

~~function to do ... ~~

Description

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

Usage

relatives(term, names, factors)

Arguments

term ~~Describe term here~~
names ~~Describe names here~~
factors ~~Describe factors 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'

...

Warning

....

Note

~~further notes~~

~Make other sections like Warning with section{Warning }{....} ~

Author(s)

~~who you are~~

References

~put references to the literature/web site here ~

See Also

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

Examples

##---- 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 (term, names, factors) 
{
    is.relative <- function(term1, term2) {
        all(!(factors[, term1] & (!factors[, term2])))
    }
    if (length(names) == 1) 
        return(NULL)
    which.term <- which(term == names)
    (1:length(names))[-which.term][sapply(names[-which.term], 
        function(term2) is.relative(term, term2))]
  }

[Package biology version 1.0 Index]