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 select Configure Build Tools ... a window will pop up
  • In the Project Options window that came up select Package for the parameter Project 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


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