Spec Design Analysis

Fundamentally, the spec of a ChRIS plugin is that it can be executed as

/path/to/interpreter /path/to/program [args...] /data/incoming/ /data/outgoing/

Existing programs cannot usually be executed in ChRIS as is: it is almost always necessary to write a (Python) wrapper around an existing program.

The spec is very minimal so much is left to the responsibility of plugin code, such as the logic for common and menial functionality such as getting the name for input files and creating a name for output files.

Examples:

Plugins following the naming convention pl-pfdo-* have duplicated code for reading input files and output files.

https://github.com/fnndsc/?q=pl-pfdo&type=all&language=&sort=

It is common for plugins to implement some kind of argument to select input files.

• https://github.com/FNNDSC/chrisapp/issues/6
• https://github.com/FNNDSC/cookiecutter-chrisapp/issues/10
• https://github.com/FNNDSC/pl-fetal-brain-assessment/blob/95b9b8544fe98b212f2acc60ad2248bc9d7c239a/fetal_brain_assessment/fetal_brain_assessment.py#L86-L93
• https://github.com/FNNDSC/pl-fetal-brain-mask/blob/c038c29fe39c58c48616b770ffc0ce41897c6e37/fetal_brain_mask/app.py#L84-L91
• https://github.com/FNNDSC/pl-smoothness-error/blob/9675b0ffa70403960583ec8f3154097d26cc821b/smoothness_error/app.py#L54-L69