addinsOutline v0.1.6

0

Monthly downloads

0th

Percentile

'RStudio' Addins for Show Outline of a R Markdown/'LaTeX' Project

'RStudio' allows to show and navigate for the outline of a R Markdown file, but not for R Markdown projects with multiple files. For this reason, I have developed several 'RStudio' addins capable of show project outline. Each addin is specialized in showing projects of different types: R Markdown project, 'bookdown' package project and 'LaTeX' project. There is a configuration file that allows you to customize additional searches.

Readme

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()

Functions in addinsOutline

Name Description
run_addinsOutline_Rmd Addin for Displays Outline of an R Markdown Project
run_addinsOutline_tex Addin for Displays Outline of an LaTeX Project
run_addinsOutline_Rmd_bookdown Addin for Displays Outline of an Bookdown Project
copy_file_config_ini_new Copy Configuration File from Outline in Working Directory
No Results!

Vignettes of addinsOutline

Name
Intro.Rmd
No Results!

Last month downloads

Details

Type Package
Date 2019-10-29
License GPL-3
Encoding UTF-8
LazyData true
URL https://github.com/calote/addinsOutline
BugReports https://github.com/calote/addinsOutline/issues
RoxygenNote 6.1.1
VignetteBuilder knitr
NeedsCompilation no
Packaged 2019-11-29 09:27:15 UTC; calvo
Repository CRAN
Date/Publication 2019-12-02 16:20:09 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/addinsOutline)](http://www.rdocumentation.org/packages/addinsOutline)