rock (version 0.8.1)

inspect_coded_sources: Read sources from a directory, parse them, and show coded fragments and code tree

Description

This function combines successive calls to parse_sources(), collect_coded_fragments() and show_inductive_code_tree().

Usage

inspect_coded_sources(
  path,
  parse_args = list(extension = "rock|dct", regex = NULL, recursive = TRUE,
    ignoreOddDelimiters = FALSE, encoding = rock::opts$get("encoding"), silent =
    rock::opts$get("silent")),
  fragments_args = list(codes = ".*", context = 0),
  inductive_tree_args = list(codes = ".*", output = "both", headingLevel = 3),
  deductive_tree_args = list()
)

Value

The parsedSources object.

Arguments

path

The path containing the sources to parse and inspect.

parse_args

The arguments to pass to parse_sources().

fragments_args

The arguments to pass to collect_coded_fragments().

inductive_tree_args

The arguments to pass to show_inductive_code_tree().

deductive_tree_args

Not yet implemented.

Examples

### Get path to example source
examplePath <-
  system.file("extdata", package="rock");

### Inspect a selection of example sources - this takes too long
### to test, so hence the 'donttest' directive.
# \donttest{
rock::inspect_coded_sources(
  examplePath,
  parse_args = list(regex = "test(.txt|.rock)")
);
# }