diff README.md @ 4:649eb2ea2f49 draft

planemo upload for repository https://github.com/CHESSComputing/ChessAnalysisPipeline/tree/galaxy commit 1401a7e1ae007a6bda260d147f9b879e789b73e0
author kls286
date Tue, 28 Mar 2023 15:37:28 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Tue Mar 28 15:37:28 2023 +0000
@@ -0,0 +1,30 @@
+### Pipeline
+This package conains proof of concepts pipeline framework for workflow
+execution. It requires proper configuration of pipeline in terms classes, e.g.
+```
+# pipeline deifinition as sequence of objects
+pipeline:
+  - reader.Reader
+  - processor.Processor
+  - fitter.Fitter
+  - processor.Processor
+  - writer.Writer
+  - fitter.Fitter
+  - writer.Writer
+
+# specific object parameters, e.g. our reader accepts fileName=data.csv
+reader.Reader:
+  fileName: data.csv
+
+
+# specific object parameters, e.g. our writer accepts fileName=data.out
+writer.Writer:
+  fileName: data.out
+```
+
+Then, you may execute this pipeline as following:
+```
+./runner.py --config config.yaml
+```
+and, check the output in `data.out` file.
+