README.md

poissontemplate

poissontemplate provides a custom pkgdown template for Poisson consulting packages. Please don’t use it for your own package.

Setup

In every package where you need to set up poissontemplate usage, run

poissontemplate::use_poisson_pkgdown()

Installation

Release

To install the release version from CRAN.

install.packages("poissontemplate")

The website for the release version is at https://poissonconsulting.github.io/poissontemplate/.

Development

To install the development version from r-universe.

install.packages("poissontemplate", repos = c("https://poissonconsulting.r-universe.dev", "https://cloud.r-project.org"))

or from GitHub

# install.packages("remotes")
remotes::install_github("poissonconsulting/poissontemplate")

Then contact the owner of Poisson consulting Plausible account to have a domain set up. Once it is done, amend and add the following lines to the pkgdown configuration file:

includes:
    in_header: |
      <script defer data-domain="{YOUR DOMAIN},poissonconsulting.ca" src="https://plausible.io/js/plausible.js"></script>  

Relevant resources

• pkgdown documentation about theming: https://pkgdown.r-lib.org/articles/customise.html#theming
• pkgdown documentation on template packages: https://pkgdown.r-lib.org/articles/customise.html#template-packages