write_sigs | R Documentation |
Writes a list of function signatures to a file.
write_sigs(x, file = stdout(), ...) ## Default S3 method: write_sigs(x, file = stdout(), ...) ## S3 method for class 'siglist' write_sigs(x, file = stdout(), ...) ## S3 method for class 'list' write_sigs(x, file = stdout(), ...) ## S3 method for class 'environment' write_sigs(x, file = stdout(), ...) ## S3 method for class 'character' write_sigs(x, file = stdout(), ...)
x |
A list of function signatures. See details. |
file |
A file path or connection to write the output to (stdout by default). |
... |
passed to |
Where x
is an object of class siglist
, the
function essentially calls writeLines(tostring(x)
.
If the input is a single function signature (of class sig
),
then it is coerced into a siglist
. If the input is an
environment or path to a file, then list_sigs
is called on
the input before writing.
A character vector of the lines that were written to file is invisibly returned. Mostly invoked for the side effect of writing function signatures to a file.
#Step by step: #First, list some sigs. utils_sigs <- list_sigs(pkg2env(utils)) #Without a file argument, sigs are just printed to the console. head(write_sigs(utils_sigs)) #Write to a file tmpf <- tempfile("sig", fileext = ".R") write_sigs(utils_sigs, tmpf) #Open the file we've just written readLines(tmpf, n = 6) #Can also list and write in one line. tmpf2 <- tempfile("sig", fileext = ".R") write_sigs(pkg2env(grDevices), tmpf2) #Single sigs are coerced to siglists write_sigs(sig(stats::var))
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.