Skip to content
'RStudio' Addins for Show Outline of a R Markdown/'LaTeX' Project
R
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R
inst
man
vignettes
.Rbuildignore Version 0.1.6 (29-10-2019 a 11h26) envío a win-builder. Oct 29, 2019
.gitignore
DESCRIPTION
LICENSE.md
NAMESPACE
NEWS.md
README.md
addinsOutline.Rproj
cran-comments.md

README.md

addinsOutline

CRAN_Release_Badge CRAN_Download_Badge

The goal of "addinsOutline" is to facilitate navigation through the files that constitute a R Markdown, LaTeX or other project.

This 'RStudio' addins will show a list of the different sections established in the project and clicking on any element shown in the list will cause 'RStudio' to show that section by opening the file that contains it if it was not already open previously.

In addition, by modifying the configuration file "addinsOutline_ini.txt" that can be copied to the project folder, not only the sections could be searched, but it could also be located for example: tables created with knitr::kable(), graphics inserted with knitr::insert_graphics(), labels created with \label in documents LaTeX, etc.

There are different functions to activate the addins corresponding to the type of project:

  • run_addinsOutline_Rmd(): R Markdown projects
  • run_addinsOutline_Rmd_bookdown(): Bookdown projects (select the file _bookdown.yml or index.Rmd)
  • run_addinsOutline_tex(): LaTeX projects

Installation

You can install the released version of addinsOutline from CRAN with:

install.packages("addinsOutline")

# For dev version
devtools::install_github("calote/addinsOutline")

Example

This is a basic example which shows you how activate the Addins for R Markdown projects:

library(addinsOutline)
run_addinsOutline_Rmd()

The default AddinsOutline is displayed in an external browser (see "shiny::browserViewer"), but can be configured to act as a dialogue in 'RStudio' (see "shiny::dialogViewer") or in the "Viewer" panel of RStudio (see "shiny::paneViewer"). It can be customized by modifying the "addinsOutline" option as follows:

  • "dialogViewer"
options("addinsOutline"="dialog")
  • "paneViewer"
options("addinsOutline"="pane")
  • "browserViewer" (default)
options("addinsOutline"="browser")

The next code will copy the configuration file "addinsOutline_ini.txt" to the current working directory

copy_file_config_ini_new()
You can’t perform that action at this time.