showTypeInfo: Display information about argument types

Description Usage Arguments Value Author(s) See Also Examples

Description

This generic function returns type specifications as a list. Elements in the list contain information about different parts of the signature. The order and white spece of the list suggests structure of the type specification.

showTypeInfo is usually invoked with a single argument, the name of the function with type information.

Usage

1
showTypeInfo(object, name=character(), prefix="", ...)

Arguments

object

The object about which type information is required

name

Class name, not normally specified by user.

prefix

Used by methods to ensure pretty indentation type specifications.

...

Additional arguments used for derivatives of NamedTypeTest, not noramlly assigned by user.

Value

A list containing type information for def

Author(s)

MT Morgan <mtmorgan@fhcrc.org>

See Also

typeInfo

Examples

1
2
3
4
5
6
foo <- function(x) { return(x) }
typeInfo( foo ) <- SimultaneousTypeSpecification(
  TypedSignature( x = "numeric" ),
  returnType = "numeric" )
res <- showTypeInfo( foo )
cat( res, sep="\n" )


Search within the TypeInfo package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.