showTypeInfo {TypeInfo}R Documentation

Display information about argument types

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

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.

Details

Value

A list containing type information for def

Note

Author(s)

MT Morgan <mtmorgan@fhcrc.org>

References

See Also

typeInfo

Examples

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

[Package TypeInfo version 1.2.0 Index]