Skip to contents

Initial setup for Roundtable Reports

initial-setup.Rmd

Install Required Software

  1. Open the Company Portal on your computer
  2. Find and install two items:
    • R for Windows
    • RStudio

Create a folder for building the reports

  1. Open RStudio. It might ask you to choose your version of R. Just accept the default (machine 64-bit version).
  2. In the RStudio menubar go to File > New Project…
    • click on “New Directory” followed by “New Project”
    • enter a name for your folder (e.g. “roundtable reports”)
    • choose a location for this folder (e.g. “~/Documents”)
    • click “Create Project”

Install the RoundtableReporting package

  1. In the RStudio menubar go to Tools > Global Options
    • select Packages from the left-hand list
    • under “Secondary repositories”, click “Add”
    • enter a name (e.g. timbp) and the URL https://drat.timbp.com
    • click “OK” and “OK”.
  2. In the bottom right pane of RStudio find the “Packages” tab.
    • Click “Install” (top left of the packages pane – very small writing)
    • In the dialog that opens, type “RoundtableReporting”
    • Check that “Include dependencies” is ticked.
    • Click “Install”.
  3. Once installation completes, go to the RStudio Console (left hand pane)
    • enter the following lines:
     library(RoundtableReporting)
 get_default_config()
  4. Switch to the Files tab in RStudio’s bottom right pane. You should see report_settings.yaml and figure_settings.yaml.

Your setup is now complete. You should not need to do these steps again.

You can now create a report: vignette("creating-reports").