_pkgdown.yml

url: https://frbcesab.github.io/rcompendium

template:
  bootstrap: 5

reference:
- title: Prerequisites
  desc: |
    High level overview of the package
  contents:
  - rcompendium

- title: Setup functions
  desc: |
    These four functions are usually the only ones user needs to run. The use of
    `set_credentials` is strongly recommended to permanently store user 
    information (name, email, orcid, etc.) in the `.Rprofile`. This function 
    must be run one time. The function `new_package` must be used to create an
    R package structure whereas `new_compendium` creates a new research 
    compendium structure (i.e. R package structure with some additional 
    files/folders). After that user can start to develop his/her project and
    run `refresh` to frequently update the package/compendium components (`Rd` 
    files, `NAMESPACE`, dependencies, badges, `README.md`, etc.)
  contents:
  - set_credentials
  - new_package
  - new_compendium
  - refresh
  
- title: Create files
  desc: |
    These function write files specific to R package and research compendium 
    (`add_makefile`). They are called by the main functions `new_package`, 
    `new_compendium`, and `refresh` but they also can be used to overwrite files
    (with `overwrite = TRUE`) in case of broken code. When `open = TRUE` and
    `overwrite = FALSE` (default) files are open in the editor.
  contents:
  - add_description
  - add_license
  - add_package_doc
  - add_citation
  - add_code_of_conduct
  - add_contributing
  - add_testthat
  - add_vignette
  - add_readme_rmd
  - add_compendium
  - add_makefile
  - add_renv
  - add_dockerfile

- title: README badges
  desc: |
    These functions add badges to the `README.Rmd`. They are called by the main
    functions `new_package`, `new_compendium`, and `refresh` but they also can 
    be used to update badges if license, lifecycle, repository status change or 
    to update number of dependencies (`add_dependencies_badge`).
  contents: 
  - add_cran_badge
  - add_dependencies_badge
  - add_license_badge
  - add_lifecycle_badge
  - add_repostatus_badge
  - add_github_actions_check_badge
  - add_github_actions_pkgdown_badge
  - add_github_actions_codecov_badge
  - add_codecov_badge
  
- title: Advanced functions
  desc: |
    These functions update fields in `DESCRIPTION` (`add_dependencies` and 
    `add_r_depend`), edit files (`add_to_gitignore` and `add_to_buildignore`),
    or write configuration files (`add_github_actions_check`, 
    `add_github_actions_pkgdown`, `add_github_actions_codecov`, and
    `add_github_actions_render`).
  contents: 
  - add_dependencies
  - add_r_depend
  - add_to_gitignore
  - add_to_buildignore
  - add_github_actions_check
  - add_github_actions_pkgdown
  - add_github_actions_codecov
  - add_github_actions_render
  - add_github_actions_citation
  - add_github_actions_document
  
- title: Utilities functions
  desc: |
    These functions return objects but do not edit any file.
  contents: 
  - get_licenses
  - get_all_dependencies
  - get_all_functions
  - get_minimal_r_version