summarise_model {assertHE} | R Documentation |
Summarise the model functions in a single folder.
Description
Summarise the model functions in a single folder.
Usage
summarise_model(
project_path = ".",
foo_folder = "R",
exclude_files = NULL,
exclude_dirs = NULL,
test_folder = NULL,
output_format = "dataframe"
)
Arguments
project_path |
path to the project folder, if not provided, will use current working directory. |
foo_folder |
path to folder containing all functions for the model |
exclude_files |
A regular expression for files to NOT process (basename) |
exclude_dirs |
A regular expression for directories to NOT process (dirname) |
test_folder |
folder containing all tests |
output_format |
output format to use, defaults to dataframe, options include latex and word. |
Value
dataframe with three columns. 'foo_string' contains function names, 'foo_location' contains the location of the function definitions, 'test_location' contains the locations of tests for each function (both file and line number).
Examples
project_path <- assertHE_example("example_project")
foo_folder <- "R"
test_folder <- "tests/testthat"
summarise_model(
project_path = project_path,
foo_folder = foo_folder,
test_folder = test_folder
)
summarise_model(
project_path = project_path,
foo_folder = foo_folder,
test_folder = NULL
)
[Package assertHE version 1.0.0 Index]