create_table_of_contents: Create a Table of Contents

View source: R/S03_Utilities.R

create_table_of_contentsR Documentation

Create a Table of Contents

Description

Given a path to an R script, creates a table of contents by searching for section headers of the form: #### X) Label #### where X is a numbering scheme (e.g.,1, 2.1, 3.2.1) with periods denoting nested sub-sections.

Usage

create_table_of_contents(file_path)

Arguments

file_path

An absolute path to the R script.

Value

Outputs a message to the R console window with the table of contents.


rettopnivek/arfpam documentation built on Oct. 20, 2024, 7:24 p.m.