This guide provides instructions for contributing static design objects to the library at DeclareDesign.org/library. Please note, designs should be submitted as
.Rmd files (vignettes), and will not be added to the CRAN version of the
A design is an object of class
design, created by concatenating a series of
declare_* calls using the
+ operator in
Your design should be submitted to
DesignLibrary as an
.Rmd vignette located in the vignette subfolder of the github repository: see here.
For an example of how to write such a vignette, see the example design entry.
You should submit your design via a pull request to https://github.com/DeclareDesign/DesignLibrary/. This will typically involve forking the repository, creating a new branch, adding your design to the vignettes folder, and then submitting a pull request to the
When you submit the pull request, you should see a pull request template, which contains a checklist. This checklist covers additional points addressed below.
You should add a row with:
keywords, separated by commas
Very often, more complicated designs will rely on external data. If your design requires external data to run, please make sure that it is sourced into your vignette through a publicly accessible URL. Our example design entry gives one example of how you might read in data from an external website. We will not accept any objects in a pull request aside from an
Just post an issue and we’ll get right on it.