R Package Structure

The standard R package directory layout uses R/ for functions, man/ for documentation, tests/ for unit tests, vignettes/ for tutorials, src/ for compiled code, data/ for datasets, and inst/ for miscellaneous files. Each directory serves a specific structural purpose.

You configure .Rbuildignore to exclude files from the package build bundle and .gitignore to exclude files from version control. Both build control files manage package contents but target different stages of the development lifecycle.

R package states differentiate between Source, Bundled, Binary, Installed, and In-memory forms. Understanding these package states clarifies how directory layouts transform into distributable and loadable formats.

You place raw datasets in the data-raw/ directory and compiled code in the src/ directory. The data/ directory holds formatted package data, ensuring proper separation of raw inputs and final outputs.

You check R package structure using usethis helpers and structure checking functions to verify correct directory placement. This avoids common pitfalls like missing required folders or incorrect build configuration file setups.

The vignettes/ directory is optional for a valid R package build, whereas R/ and man/ are required. Vignettes provide long-form documentation and tutorials but are not mandatory for basic package states.