dark-peak-analytics / assertHE

R package to assist in the verification of health economic decision models.
https://dark-peak-analytics.github.io/assertHE/
Other
4 stars 10 forks source link

Function summary table generator #5

Closed RobertASmith closed 9 months ago

RobertASmith commented 9 months ago

The tabulate_functions_in_folder function is designed to:

Next steps:

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

RobertASmith commented 9 months ago

image

The foo fighters, see name of branch!

RobertASmith commented 9 months ago

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:

image

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

@bitowaqr for visibility.