missing_docs {fritools} | R Documentation |
Find Missing Documentation
Description
For fritools, we make exhaustive use of categorizing functions into families with the 'See also' section of the man pages (which are generated by the @family tags in the code files).
Usage
find_missing_see_also(path, list_families = TRUE)
find_missing_family(path, list_families = TRUE, clean = TRUE)
Arguments
path |
Path to a (package) directory. |
list_families |
List the function families defined so far. |
clean |
Remove temporary directory? |
Value
For 'find_missing_see_also': a character vector of man pages with missing 'See also' sections.
For 'find_missing_family': a character vector of function names with missing '@family' tags.
See Also
Other searching functions:
compare_vectors()
,
file_modified_last()
,
find_files()
,
fromto()
,
grep_file()
,
search_files()
,
search_rows()
,
summary.filesearch()
[Package fritools version 4.3.0 Index]