/
Settings for automated documentation
Settings for automated documentation
If your project is not already loaded in Rstudio load it: Go to the File
tab, select Open Project
, browse to the location of your project directory and double click on the file dsFirstPack.Rproj
.
Set the Rstudio components required to generate the documentation of each function from the header of our function script (the header of the function will be explained in details later):
- Go to the tab
Build
and selectConfigure Build Tools ...
a window will pop up - In the
Project Options
window that came up selectPackage
for the parameterProject build tools
- Enable the option
Generate documentation with Roxygen
and another small window will appear - Enable all the options in the new window titled
Roxygen options
- Click the
OK
button on all windows to finish
Related content
The R help function
The R help function
More like this
Finalize and push package to GitHub
Finalize and push package to GitHub
More like this
Client side description file and folders
Client side description file and folders
More like this
Become familiar with R Studio and basic concepts of R
Become familiar with R Studio and basic concepts of R
More like this
Start developments
Start developments
More like this
Vignettes and R notebooks
Vignettes and R notebooks
More like this
DataSHIELD Wiki by DataSHIELD is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License. Based on a work at http://www.datashield.ac.uk/wiki