TypeInfo: Optional Type Specification Prototype
Version 1.42.0

A prototype for a mechanism for specifying the types of parameters and the return value for an R function. This is meta-information that can be used to generate stubs for servers and various interfaces to these functions. Additionally, the arguments in a call to a typed function can be validated using the type specifications. We allow types to be specified as either i) by class name using either inheritance - is(x, className), or strict instance of - class(x) %in% className, or ii) a dynamic test given as an R expression which is evaluated at run-time. More precise information and interesting tests can be done via ii), but it is harder to use this information as meta-data as it requires more effort to interpret it and it is of course run-time information. It is typically more meaningful.

AuthorDuncan Temple Lang Robert Gentleman (<rgentlem@fhcrc.org>)
Bioconductor views Infrastructure
Date of publicationNone
MaintainerDuncan Temple Lang <duncan@wald.ucdavis.edu>
LicenseBSD
Version1.42.0
Package repositoryView on Bioconductor
InstallationInstall the latest version of this package by entering the following in R:
source("https://bioconductor.org/biocLite.R")
biocLite("TypeInfo")

Popular man pages

checkReturnValue: Verify the return value from the function has the appropriate...
hasParameterType: Functions to query existence of specific type information
IndependentTypeSpecification: Create separate type information for different parameters.
IndependentTypeSpecification-class: Class "TypeSpecification" and derived class
paramNames: Compute the names of all the specified parameters in a...
rewriteTypeCheck: Insert code to support type validation
TypedSignature: Constructor for a TypedSignature object
See all...

All man pages Function index File listing

Man pages

checkArgs: Validate the arguments in a call to a typed function.
checkReturnValue: Verify the return value from the function has the appropriate...
ClassNameOrExpression-class: Class "ClassNameOrExpression" to represent type information...
DynamicTypeTest-class: Class "DynamicTypeTest" for computed tests on objects.
hasParameterType: Functions to query existence of specific type information
IndependentTypeSpecification: Create separate type information for different parameters.
IndependentTypeSpecification-class: Class "TypeSpecification" and derived class
NamedTypeTest-class: Class "NamedTypeTest" and sub-classes for tests on class of...
paramNames: Compute the names of all the specified parameters in a...
ReturnTypeSpecification: Constructor for specifying information about only the return...
rewriteTypeCheck: Insert code to support type validation
showTypeInfo: Display information about argument types
SimultaneousTypeSpecification: Create type signature information governing parameters in a...
TypedSignature: Constructor for a TypedSignature object
TypedSignature-class: Class "TypedSignature" representing type information about...
typeInfo: Get or set type information for a function.

Functions

ClassNameOrExpression-class Man page
DynamicTypeTest Man page
DynamicTypeTest-class Man page
IndependentTypeSpecification Man page Source code
IndependentTypeSpecification-class Man page
InheritsTypeTest Man page Source code
InheritsTypeTest-class Man page
NamedTypeTest-class Man page
ReturnTypeSpecification Man page Source code
ReturnTypeSpecification-class Man page
SimultaneousTypeSpecification Man page Source code
SimultaneousTypeSpecification-class Man page
StrictIsTypeTest Man page Source code
StrictIsTypeTest-class Man page
TypeSpecification-class Man page
TypedSignature Man page Source code
TypedSignature-class Man page
checkArgs Man page
checkArgs,IndependentTypeSpecification-method Man page
checkArgs,InheritsTypeTest-method Man page
checkArgs,SimultaneousTypeSpecification-method Man page
checkArgs,function-method Man page
checkArgs,missing-method Man page
checkArgs-methods Man page
checkReturnValue Man page Source code
coerce,character,NamedTypeTest-method Man page
hasParameterType Man page
hasParameterType,IndependentTypeSpecification-method Man page
hasParameterType,NamedTypeTest-method Man page
hasParameterType,SimultaneousTypeSpecification-method Man page
hasParameterType,TypeSpecification-method Man page
hasParameterType,TypedSignature-method Man page
hasParameterType,function-method Man page
hasReturnType Man page
hasReturnType,SimultaneousTypeSpecification-method Man page
hasReturnType,TypeSpecification-method Man page
hasReturnType,TypedSignature-method Man page
hasReturnType,function-method Man page
initialize,TypeSpecifcation-method Man page
initialize,TypeSpecification-method Man page
isLiteral Source code
maybeInheritsTypeTest Source code
paramNames Man page
paramNames,IndependentTypeSpecification-method Man page
paramNames,NamedTypeTest-method Man page
paramNames,ReturnTypeSpecification-method Man page
paramNames,SimultaneousTypeSpecification-method Man page
paramNames,TypeSpecification-method Man page
paramNames,TypedSignature-method Man page
paramNames,function-method Man page
prefixIncr Source code
print.IndependentTypeSpecification Source code
print.SimultaneousTypeSpecification Source code
print.TypedSignature Source code
rewriteLanguage Source code
rewriteTypeCheck Man page
showTypeInfo Man page
showTypeInfo,ANY-method Man page
showTypeInfo,DynamicTypeTest-method Man page
showTypeInfo,IndependentTypeSpecification-method Man page
showTypeInfo,InheritsTypeTest-method Man page
showTypeInfo,SimultaneousTypeSpecification-method Man page
showTypeInfo,StrictIsTypeTest-method Man page
showTypeInfo,TypedSignature-method Man page
showTypeInfo,function-method Man page
showTypeInfoReturnType Source code
typeInfo Man page Source code
typeInfo<- Man page
typeInfoValidationError Source code

Files

DESCRIPTION
NAMESPACE
R
R/Classes.S
R/checkArgs.S
R/print.S
R/rewrite.S
R/support.S
Todo.html
build
build/vignette.rds
inst
inst/doc
inst/doc/TypeInfoNews.R
inst/doc/TypeInfoNews.Rnw
inst/doc/TypeInfoNews.pdf
man
man/ClassNameOrExpression-class.Rd
man/DynamicTypeTest-class.Rd
man/IndependentTypeSpecification-class.Rd
man/IndependentTypeSpecification.Rd
man/NamedTypeTest-class.Rd
man/ReturnTypeSpecification.Rd
man/SimultaneousTypeSpecification.Rd
man/TypedSignature-class.Rd
man/TypedSignature.Rd
man/checkArgs.Rd
man/checkReturnValue.Rd
man/hasParameterType.Rd
man/paramNames.Rd
man/rewriteTypeCheck.Rd
man/showTypeInfo.Rd
man/typeInfo.Rd
tests
tests/ReturnExperiments.S
tests/aggregate.S
tests/calls.S
tests/check.S
tests/copyEnv.R
tests/copySubstitute.R
tests/copySubstitute.S
tests/degenerate.S
tests/doubleEval.S
tests/foo.S
tests/independent.S
tests/invisible.S
tests/loop.S
tests/match.arg.S
tests/return.S
tests/rewrite.S
tests/rowQ.S
tests/simple.S
vignettes
vignettes/Rnews.sty
vignettes/TypeInfoNews.Rnw
vignettes/TypeSpecificationConcept.tex
vignettes/outline.html
TypeInfo documentation built on May 20, 2017, 10:53 p.m.

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

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

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