search

zavolanlab / bindz-rbp

RBP module for bindz, a bioinformatics tool to detect regulators' binding sites on RNA sequences.
https://github.com/zavolanlab/bindz-rbp
Apache License 2.0
7 stars 1 forks source link

Pipeline documentation missing #13

Closed AngryMaciek closed 4 years ago

AngryMaciek commented 4 years ago

Is your feature request related to a problem? Please describe. It is generally a bad idea to merge not documennted code however we have a limitted manpower on this project and I do not want to stop others from the progress. Therefore I will pull request the initial version of the snakemake pipeline without the documentation of the rules.

Describe the solution you'd like At some point in the future the file ./workflow/documentation.md should contain the documentation for all the rules of the pipeline (just as in the zarp project).

AngryMaciek commented 4 years ago

As the core code for version 1.0.0 is finished we have to get back to this issue.
I am too busy with other projects to start this up, @krish8484 - could you please update the documentation file (in Markdown) according to the example for zarp? https://git.scicore.unibas.ch/zavolan_group/pipelines/zarp/-/blob/dev/pipeline_documentation.md

We do not use any external tools so you might skip the giant table.

AngryMaciek commented 4 years ago

Closed with #37