Package 'addinsOutline'

Title: 'RStudio' Addins for Show Outline of a R Markdown/'LaTeX' Project
Description: '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.
Authors: Pedro L. Luque-Calvo [aut, cre]
Maintainer: Pedro L. Luque-Calvo <[email protected]>
License: GPL-3
Version: 0.1.6
Built: 2025-03-13 04:16:49 UTC
Source: https://github.com/calote/addinsoutline

Help Index

Copy Configuration File from Outline in Working Directory

Description

Copy configuration file from outline in working directory to search for additional terms in our R Markdown or LaTeX project.

Usage

copy_file_config_ini_new(path_to = NULL, overwritefile = TRUE)

Arguments

path_to

path where the configuration file will be copied
overwritefile

logical variable; if TRUE will overwrite the file if it already exists

Details

The name of the configuration file is "addinsOutline_ini.txt".

In the configuration file you can use regular expressions with the help of the functions of the "stringr" package, to perform additional custom searches.

Make a copy of this file to see how new searches are defined.

The following strings serve to distinguish which types of files will be used:

- "rmd": R Markdown files

- "rmdbd": Bookdown files

- "tex": LaTeX files

Value

Copy configuration file from outline in working directory

See Also

The function run_addinsOutline_Rmd(), run_addinsOutline_Rmd_bookdown() and run_addinsOutline_tex().

Examples

if (interactive()) {
   library(addinsOutline)
   copy_file_config_ini_new()
}

Addin for Displays Outline of an R Markdown Project

Description

Addin for displays outline of an R Markdown project with and without child files.

Usage

run_addinsOutline_Rmd()

Value

'RStudio Addin' with browserViewer(). This 'RStudio' addin will show a list of the different sections established in the R Markdown 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.

See Also

The function run_addinsOutline_Rmd_bookdown() and run_addinsOutline_tex().

Examples

if (interactive()) {
   library(addinsOutline)
   run_addinsOutline_Rmd()
}

Addin for Displays Outline of an Bookdown Project

Description

Addin for displays outline of an bookdown project (R Markdown files in directory project).

Usage

run_addinsOutline_Rmd_bookdown()

Value

RStudio Addin with browserViewer() This 'RStudio' addin will show a list of the different sections established in the 'bookdown' project (R Markdown files in directory 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. To open a bookdown project select the file _bookdown.yml or index.Rmd.

See Also

The function run_addinsOutline_tex() and run_addinsOutline_Rmd().

Examples

if (interactive()) {
   library(addinsOutline)
   run_addinsOutline_Rmd_bookdown()
}

Addin for Displays Outline of an LaTeX Project

Description

Addin for displays outline of an LaTeX Project with and without child files insert with: \input{} or \include{}.

Usage

run_addinsOutline_tex()

Value

Addin 'RStudio' with browserViewer() This 'RStudio' addin will show a list of the different sections established in the LaTeX 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.

See Also

The function run_addinsOutline_Rmd() and run_addinsOutline_Rmd_bookdown().

Examples

if (interactive()) {
   library(addinsOutline)
   run_addinsOutline_tex()
}