R/helloworld.r

In joey711/testpkg: More higher order functions for R.

##############################################################
#' The title, in this case: Helloworld-ify the argument.
#'
#' Some additional details about this S4 generic and its 
#' The extra blank line between this section and the title is
#' critical for roxygen2 to differentiate the title from the
#' description section.
#'
#' @param x Description of \code{x}. The main argument in this
#'  example. Most often has such and such properties.
#'
#' @param y Description of \code{y}. An argument that is rarely
#'  used by \code{"helloworld"} methods. 
#'
#' @param ... Additional argument list that might not ever
#'  be used.
#'
#' @usage helloworld(x, y, ...)
#'
#' @return A helloworld-ified argument. Oh, you'll see.
#' 
#' @seealso \code{\link{print}} and \code{\link{cat}}
#' 
#' @export
#' @docType methods
#' @rdname helloworld-methods
#'
#' @import phylobase
#' @import vegan
#' @import igraph
#' @importFrom multtest mt.maxT
#' @importFrom multtest mt.minP
#'
#' @examples
#' helloworld("thisismystring")
#' helloworld(char2helloworld("thisismystring"))
#' helloworld(matrix(0,3,3))
#' helloworld(c(0,0,0))
#' helloworld(list(0,0,0))
#' helloworld(c(0,0,0))
#' helloworld(function(x){print(x)})
#' helloworld(integer(0))
#' helloworld(array(0))
#' mychar <- char2helloworld(c("this","is","my","character","vector"))
#' helloworld(mychar)
#' mychar
#' print(mychar)
#' show(mychar)
setGeneric("helloworld", function(x, y, ...){
	cat("Hello World!")
	cat("\n")
	standardGeneric("helloworld")
})
#' @rdname helloworld-methods
#' @aliases helloworld,ANY,ANY-method
setMethod("helloworld", "ANY", function(x, y, ...){
	cat(class(x))
})
#' @rdname helloworld-methods
#' @aliases helloworld,character,ANY-method
setMethod("helloworld", "character", function(x){
	show(x)
})
#' @rdname helloworld-methods
#' @aliases helloworld,character,character-method
setMethod("helloworld", c("character", "character"), function(x, y){
	show(x)
})
#' @rdname helloworld-methods
#' @aliases helloworld,phylo4,ANY-method
setMethod("helloworld", "phylo4", function(x){
	cat("Hello World! This is a tree:", fill=TRUE)
	show(x)
})
##############################################################