flowRSignature DB

Signature Database

Search through all R functions flowR knows, using its signature database (last updated , only most recent package versions).

What the database knows, by language
RCC++FortranRust
exists, signatureformals, defaultsregistered name, arityregistered name, arityname, arityextendr, savvy, extern "C" names, arity
argumentsroles, forced, readread, written, escapessome (Rcpp often unknown)read, written (INTENT)not written, where the types say so
contractsyesnononono
recyclingyesnononono
global stateoptions, env, RNG, files, ...globals, RNG, I/O, envsomeCOMMON, I/Ostatics, RNG, I/O, env
pure, errorsyesyes, pure only if every callee is knownsomeyes (STOP)panics, R errors; never pure
parallel, hardwarenoOpenMP, threads, SIMD, asmsame!$OMPrayon, threads, SIMD, cfg
callscallees, S3/S4 dispatch.Call, .C, .Fortran, .External calls point to the routinesame

Facts on C, C++ and Fortran come from reading the sources with libclang and gfortran, on Rust from a scanner over the source text. Nothing is compiled or run. Only the #ifdef branches of one Linux build are read. A fact that could not be established is unknown, not false.

Search syntax

A query is name(arguments) [properties], every part optional. Without arguments or properties it is just a name, so +, *, [[ and %in% search for exactly that. Click an example to try it.

Names

  • * in a name matches any text, over the whole name (*csv, *read*)
  • only what that package exports
  • a lone * as the name means any function
  • between slashes, a regular expression over the whole name, ignoring case. It works for argument names too:

Arguments

  • (x, y) arguments by name, in order. Without a * the count has to match
  • has an argument called x, anywhere. x[value]? adds a role
  • the first argument has a role, the rest is anything. Several roles: [alias,forced]
  • exactly one argument, called file, with that role
  • * any number of arguments, including none. + one or more
  • one or more arguments, all with the role. [role]* zero or more, all with it
  • at least one argument has the role, the others may be anything

The function

  • a property of the call as a whole. It may come first, last or right after the name, and several add up
  • combines with arguments

Traits

  • what the name is, as the filter groups ask it: has a contract, is an S3 method, reads a file, touches the global state. Several add up:

Contracts

  • what a call has to fulfill to return normally, asked as key:value. Several add up, and a name narrows them:
  • a condition calls the function, which requires:base::is.numeric asks as well. A function from a package R does not attach on startup shows as pkg::name, and hovering any function names its package
  • a bound implying the comparison, of the value of any formal
  • anything that is no plain name also finds the contracts that write it, and the contracts calling that function

Contract keys

Kinds of parameters, for param:

Only functions with a flowR signature can answer argument and property questions, and one signature has to satisfy all of it. Typing [ or { lists the words that fit, grayed when nothing would match. The filter groups above ask the same without typing.

Argument roles

Function properties

Traits

filter: match

Type a name to search.