This is a function designed to speed up the writing of function documentation, and make a regular 'style' of function easier to repeat.
Usage
Description_Generator(
R_function_file,
boilerplate = c("#---\n", paste0("#Title: ", Function_Name, "\n"),
"#Author: Thomas Codd - https://github.com/TomCodd\n",
"#Contributor: Lucia Segovia de la Revilla - https://github.com/LuciaSegovia\n",
"#Version: V1.0.0\n", "#Changelog:\n", "\n",
"#Github: https://github.com/TomCodd/NutritionTools\n", "#---\n", "\n")
)Arguments
- R_function_file
Required - the location of the R file which contains the function you wish to generate the Description and Documentation for. Only the first function in the file will have its description generated.
- boilerplate
Optional - default:
c("#---\n", paste0("#Title: ", Function_Name, "\n"), "#Author: Thomas Codd - https://github.com/TomCodd\n", "#Contributor: Lucia Segovia de la Revilla - https://github.com/LuciaSegovia\n", "#Version: V1.0.0\n", "#Changelog:\n", "\n", "#Github: https://github.com/TomCodd/NutritionTools\n", "#---\n", "\n")- Please enter any message or further information you would like to include at the top of the function.