folderSystem: Folder hierarchy creator for academic research

View source: R/folderSystem.R

folderSystemR Documentation

Folder hierarchy creator for academic research

Description

Folder hierarchy creator for academic research

Usage

folderSystem(overwrite = FALSE)

Arguments

overwrite

Logical. Should existing template files in ⁠paper/⁠ be overwritten? Defaults to FALSE, leaving any files the user has already edited untouched.

Details

The function constructs a standardized folder hierarchy encompassing ⁠codes/⁠, ⁠data/⁠, ⁠output/⁠, ⁠paper/⁠, and ⁠document/⁠. These directories are designated for storing programming scripts, data sets, processed outputs, manuscript drafts (including related images and submission documents), and assorted materials, respectively. This organization facilitates easy retrieval of project components, ensuring that members of Dr. Hu's Amazing Team can efficiently navigate and manage shared resources. This structure is advocated for collaborative projects to maintain uniformity across team operations.

In addition, the manuscript-writing templates bundled with the package (a Quarto/Typst paper template, its main and appendix bibliographies, the OSCOLA citation style, and the citation-prefix Lua filter) are copied into the ⁠paper/⁠ folder so a new project starts ready to write.

Value

Invisibly returns NULL. Called for its side effect of creating local folders, placeholder files, a default .gitignore, and the manuscript templates under the project's working directory.


drhutools documentation built on June 4, 2026, 9:08 a.m.