search

baumer-lab / fertile

creating optimal conditions for reproducibility
GNU General Public License v3.0
52 stars 4 forks source link

documentation improvements #50

Closed ambertin closed 5 years ago

ambertin commented 5 years ago

Changed has_only_used_files() so that it doesn't duplicate the information about paths outside of the directory.

Removed several functions that did not appear user-facing from the documentation. I believe proj_render() can now be entirely internal due to the use of all of the has_rendered() checks we've added (including one I added in this commit). As a result, it's currently hidden in the documentation.

Grouped check_is_dir and check_is_file together. Also did something similar with is_r_file, is_text_file, and the other two file type checks.

I thought it worked better for this project to write the examples slightly differently than it is traditionally done. Let me know if this won't work. They currently are NOT being checked by R CMD Check but also just have "your path here"-type arguments to show a sample of how they could be used.

For all of the reproducibility checks, in the page where they're all linked together, I added short descriptions of what they do and a line of code that could be used to run them.

I did something similar with the three log functions that I kept as user-facing (log_report, log_clear and path_log), and for the proj_test collection of functions.

An image of how the documentation actually looks can be seen here:

Screen Shot 2019-03-23 at 3 45 16 PM

ambertin commented 5 years ago

Added the check_some() function, which uses tidyselect helpers to choose a selection of checks to run. Improved the README file, and also made a few other small changes to the documentation.