sample_config

Below is a sample pkgr.yml file for quick-reference.

# The version number of the config file, used to indicate the API for the config.
# Do not change.
Version: 1

# Top-level packages. Include the packages you wish to have in your environment
# Dependencies for these packages will be automatically determined and installed.
Packages:
  - pkg1
  - pkg2
  - pkg3

# CRAN-Like Repositories from which packages will be downloaded.
# The order that the repositories are listed in matters: Pkgr will look for
# each package in the first repository listed. If a package is not found in the
# first, Pkgr will check the second, then the third, etc.
# first repository listed for each
Repos:
  - companyA_repo: "https://companyA.github.io/rpkgs"
  - CRAN: "https://cran.rstudio.com"

# Path the install packages to
Library: "path/to/install/library"

# Options for Logging
# Without any options set, Pkgr will only log Info-level (and above) messages
# to the standard output device..
# To save logs to a file, use the "all" (as in "log all too").
# To save logs from the "pkgr install" command to a separate file, use the
# "install" option.
# By default, log files will be appended to each time a pkgr is run. If you would
# like the log files to be overwritten instead, set the "overwrite" option to true.
Logging:
  all: logs/all.log
  install: logs/install.log
  overwrite: true

# Package-specific Customizations
# These optional customizations should take the format
# Customizations:
#  Packages:
#    - <package name>
#      CustomizationA: <value>
#      CustomizationB: <value>
#    - <package name>
#      CustomizationA: <value>
#      CustomizationC: <value>
#  Repos:
#    - <repo name>
#      CustomizationA: <value>
#    - <repo name>
#      CustomizationB: <value>
Customizations:
  Packages:
    - pkg1:
        Suggests: true
    - pkg2:
        Type: source
  Repos:
    - companyA_repo:
        Type: source