dmdSchemeRepository

This is a repository for dmdSchemes. The schemes are in the folder schemes.

They are .tar.gz files which contains a folder named NAME_VERSION. The content of the folder depends on the schemePackageVersion.

The folder is copied into the dmdSchemePackageDir/installedSchemes folder.

Below, the different versions are explained in detail.

To add a scheme definition please either

• clone the repo and send a pull request after
  • adding the scheme definition
  • adding the new scheme definition to the file schemes/SCHEME_DEFINITIONS.yaml
• contact the maintainer of this repo at Rainer.Krug@uzh.ch

Scheme Package format 1.0.0

A scheme package is a .tar.gz file containing a folder which will be extracted to the local scheme library. The contents of the folder are as followed.

Required files

• schemePackageVersion: version of the scheme package format (1.0.0)
• NAME_VERSION.xlsx: definition including example data
• NAME_VERSION.xml: exported from NAME_VERSION.xlsx with output = complete and
  keepData = TRUE, i.e. it contains the scheme definition and the example data and is equivalent to NAME_VERSION.xlsx
• md5sum.txt: contains the md5 checksums of all files in the pckage

Supported but not required files and folders

• a folder with the name examples containing subfolders with foldes containing examples. The name of the example is the name of the subfolder under examples. The example can contain an html file with the name name_of_the_example.html which is opened automatically when calling make_example("name_of_the_example"). Otherwise, there are no restrictions to the contents of the example.
• install_R_package: R script to be executed in R (source()) to install the accompanying R package. This script will be executed when the package is installed in R. NB: It is important, that the script will always run non-interactive, as it will be used in the shiny app which does not allow interactive use/ This requires e.g. the argument update = "never" when using the remotes::install_github() command!

Repository structure

A repository consists of a folder named schemes which contains the scheme definitions as described below as well as a file containing information about the schemes in the directory. The file SCHEME_DEFINITIONS.yaml is a yaml file with

• top level: NAME_VERSION of the scheme
  • name: Name of the scheme
    • version: Version of the scheme
    • description: Description of the scheme

This site is open source. Improve this page.