Sinew Addins

There are three addins in sinew both work off of the same principle.

To access the addins load sinew and then three addins are appended to the Addins menu of RStudio.



This addin scans the file source contents and attaches namespace information.


This addin will insert above the highlighted text the output of sinew::makeOxygen.



This addin invokes a shiny gadget.

The user can select to either create a new skeleton or update an existing file. The application search for highlighted text in a number of locations in order to create the documentation.

The application has checkboxes to control what fields are in the documentation, and there is a reactive preview tab to see what the documentation looks like as fields are inserted or removed. It is useful to control the fields checked on by default and their values with sinew::sinew_opts.

Once the user is happy with the documention skeleton it can be inserted into the editor.

Creating a new skeleton:

Updating existing documentation on disk