Publishing/sharing models
Writing your own macsy-model package
The whole package structure and the corresponding files are described in the section Structure of a macsy-model package. It requires five different types of files to be complete:
a metadata.yml file (mandatory)
a README.md file (mandatory)
a LICENSE file (optional but HIGHLY recommended)
a model_conf.xml file (optional)
macsy-models definition(s) within a definitions folder (mandatory)
HMM profiles within a profiles folder (mandatory)
You can create a template for your package by using macsydata init. It will create for you:
the data package directory with the right structure.
a template of metadata.yaml .
a template of README.md file.
a generic model_conf.xml file.
a LICENSE file if –license option is set.
a COPYRIGHT file if –holders option is set.
a directory definitions with an example of model definition (model_example.xml to remove before publishing).
a directory profiles where to put the hmm profiles corresponding to the models genes.