Resolve issue 83 - Githubissues

phuse-org / valtools

Validation framework for R packages used in clinical research and drug development.

https://phuse-org.github.io/valtools/

Other

51 stars 10 forks source link

Resolve issue 83 #86

Closed mariev closed 3 years ago

mariev commented 3 years ago

closes #83

Change summary:

rename vt_scrape_tags_from to scrape_tags_from and make internal
add public function vt_scrape_function for applying scrape_tags_from on functions
add public function vt_kable_function to kable() output from ^^
resolve warning around ghostscript/pdfcrop for test cases (scope creep to run tests)
run devtools::document()

mariev commented 3 years ago

@thebioengineer what assumptions are we making for where R function documentation details are located? does scrape_tags_from(type = "functions", ...) address movement from pkg_dir/R to pkg_dir/inst/validation/?

thebioengineer commented 3 years ago

@mariev - yes, it looks at the source (pkg/R) when running normally, but when running on an installed package, it looks in the (validation) folder.

As for function name, could we use something more like vt_scrape_authors()? vt_scrape_function() makes me thing it is just for functions.

mariev commented 3 years ago

this is just for functions! there isn't an option to change the type passed to scrape_tags_from

mariev commented 3 years ago

per discussion with @thebioengineer today keeping vt_scrape_tags_from as public function, updates forthcoming

mariev commented 3 years ago

@thebioengineer ready for review - looks like all c.i. checks pass