Skip to content

Template Structure

Hugo Gruson edited this page Dec 7, 2023 · 3 revisions

Below is the folder structure of the packagetemplate with a short explanation of the function of the different files

../packagetemplate
├── .Rbuildignore
├── .github/
│   ├── .gitignore
│   └── workflows/                      # Continuous Integration (CI) GitHub Actions workflows
│       ├── R-CMD-check.yaml            # R CMD check CI workflow
│       ├── dependency-change.yaml      # Dependency analysis with details on the impact of PR on recursive and system dependencies
│       ├── pkgdown.yaml                # Automatic pkgdown (documentation website) rendering
│       ├── render_readme.yml           # Automatic rendering of README.md from README.Rmd
│       ├── test-coverage.yaml          # Automatic computation of the test coverage
│       └── update-citation-cff.yaml    # Automatic update of citation file CITATION.cff
├── .gitignore
├── .lintr                              # Settings for lintr static analysis
├── DESCRIPTION
├── LICENSE
├── LICENSE.md
├── NAMESPACE
├── NEWS.md                             # Changelog and release notes
├── R/
│   └── dev-utils.R                     # Custom bullet points for `usethis::use_release_issue()`
├── README.Rmd
├── README.md
├── _pkgdown.yml                        # pkgdown website settings: 1. Use epiversetheme theme
├── codecov.yml                         # Settings for codecov  
├── inst/
│   └── WORDLIST                        # Custom dictionary for automated spellcheck
├── man/
│   └── figures/
│       └── logo.svg                    # svg template for package hex sticker
├── tests/
│   ├── spelling.R
│   ├── testthat/
│   │   ├── helper-state.R              # testthat helper to verify global settings are not modified in tests   
│   │   ├── setup-options.R             # Settings for get warnings when partial matching is used in tests
│   │   └── test-dev-utils.R            # Verify R/dev-utils.R file is still present
│   └── testthat.R
├── tools
│   └── check.env                       # Custom setting for rcmdcheck (used in the R CMD check GitHub Actions workflow)
└── vignettes
    ├── .gitignore
    └── design-principles.Rmd           # Template for package-specific design principle vignette
Clone this wiki locally