Function summary table generator

[RobertASmith]

The tabulate_functions_in_folder function is designed to:

• extract the names of all functions used in the project folder within R scripts.
• return a dataframe with all functions listed next to the software package they are from
• allow users to exclude certain packages so as not to be overwhelmed (e.g. base R has thousands of functions).

Next steps:

• currently requires packages to be loaded to identify which package a function is from. If the package is not loaded (e.g. with library("package_name") then the function call will be identified as a function with a 'unknown' package. It would be good to use the CRAN lookup to guess the package (dangerous though for the user).
• it would be good to be able to define which of these functions have a test associated with them, another column could be added to the table to provide the file in which the function was tested (or NULL if no tests undertaken).

The aim of this is that a user reviewing a model in R will be able to see:

• the functions used by the model (and the package they are from)
• whether they have a test associated with them and where that test is!

[RobertASmith]

The foo fighters, see name of branch!

[Smit-tay]

It works, and passes tests.

[RobertASmith]

OK, so this is awful, but it does do something.

The function below looks through all functions used in the "./inst" folder in the project. It identifies the function packages, and then checks if there is a corresponding test in the 'tests' folder, the script where the function is defined, and looks for the cheers roxygen tag associated with the function. (currently references to '@family' but this will change)

assertHE::get_summary_table(path = "./inst",test_path = "../tests")

The result is a dataframe that looks like this:

@W-Mohammed could you build this package locally for this branch and try running the code above. Apologies for messy code!

@bitowaqr for visibility.