DEV_GUIDE.md

dp_tools

Very rough guidelines and order of steps

1. Define the components (assay related, but intended to be reusable, e.g. ReadsComponent should fit a number of NGS assays) including what data assets are attached Components from BulkRNASeq Example
2. Define the sample (assay specific) including what components should be attached
3. Define the dataset (assay specific) including what components should be attached (e.g. DifferentialGeneExpressionComponent is a dataset component rather than tied to a specific sample) BulkRNASeq Entities Example
4. Write a loader that connects file location knowledge and a root directory input to assemble the dataset object BulkRNASeq Loaders Example
   • Note: It is recommended to use the general data asset find function source coupled with a data asset yaml config example
5. Write checks BulkRNASeq Checks Example
6. Incorporate those checks into a VV_Protocol BulkRNASeq Protocol Example

Additional these tests show how a top level VV script would likely look

1. First loading data Excerpt Loading Test
2. Then running the protocol on the data (ignore the caplog stuff, that is part testing) Excerpt Validation Test