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 [email protected]
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.
schemePackageVersion
: version of the scheme package format (1.0.0
)NAME_VERSION.xlsx
: definition including example dataNAME_VERSION.xml
: exported fromNAME_VERSION.xlsx
withoutput = complete
and
keepData = TRUE
, i.e. it contains the scheme definition and the example data and is equivalent toNAME_VERSION.xlsx
md5sum.txt
: contains the md5 checksums of all files in the pckage
- a folder with the name
examples
containing subfolders with foldes containing examples. The name of the example is the name of the subfolder underexamples
. The example can contain anhtml
file with the namename_of_the_example.html
which is opened automatically when callingmake_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 argumentupdate = "never"
when using theremotes::install_github()
command!
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 schemename
: Name of the schemeversion
: Version of the schemedescription
: Description of the scheme