extract docs file

Share:

Description

Apply all parsers relevant to extract info from just 1 code file.

Usage

1
2
3
extract.docs.file(f, parsers = NULL, inlinedocs.exampleDir = file.path("..", 
    "..", "inst", "tests"), inlinedocs.exampleTrunk = "example.", 
    ...)

Arguments

f

File name of R code to read and parse.

parsers

Parser Functions to use to parse the code and extract documentation.

inlinedocs.exampleDir

A string pointing to the location where inlinedocs should search for external examples

inlinedocs.exampleTrunk

A string used to identify the files containing external examples in the example directory. All file names of external examples have to start with this string

...

Other arguments to pass to Parser Functions.

Author(s)

Toby Dylan Hocking <toby@sg.cs.titech.ac.jp> [aut, cre], Keith Ponting [aut], Thomas Wutzler [aut], Philippe Grosjean [aut], Markus Müller [aut], R Core Team [ctb, cph]

Examples

1
2
f <- system.file("silly","R","silly.R",package="inlinedocs")
extract.docs.file(f)

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.