bionode / bionode-watermill

💧Bionode-Watermill: A (Not Yet Streaming) Workflow Engine
https://bionode.gitbooks.io/bionode-watermill/content/
MIT License
37 stars 11 forks source link

Adds a new example pipeline and edits existing example pipeline #53

Closed tiagofilipe12 closed 7 years ago

tiagofilipe12 commented 7 years ago

This PR adds a new example pipeline intended do document an easy to use tutorial with simple NGS tools. Also it adds some changes to the existing variant calling pipeline by adding changing the size of the download size of reads to a smaller one, reducing the time to download reads as well as the download size itself.

codecov-io commented 7 years ago

Codecov Report

Merging #53 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #53   +/-   ##
=======================================
  Coverage   80.64%   80.64%           
=======================================
  Files          36       36           
  Lines         806      806           
  Branches       99       99           
=======================================
  Hits          650      650           
  Misses        156      156

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 7405aa2...ab4f92d. Read the comment docs.

thejmazz commented 7 years ago

I think the tutorial should use require('bionode-watermill') instead of require('../../../'). It would then need a little bit more instructions before to do something like:

mkdir watermill-tutorial
cd watermill-tutorial
npm init
npm install --save bionode-watermill

or maybe

git clone tutorialRepoOrBranch
thejmazz commented 7 years ago

Oh OK i see you have another "how to use in your project" part. Hmm ok, I'm not sure if ../../../ is going to be confusing to people new to node, but its probably not such a big deal.

tiagofilipe12 commented 7 years ago

For now, i think the best pratice for the tutorial would be to require('bionode-watermill') instead of the require('../../..'). Therefore, to make it less confusing, for the user, maybe the best way is to create a new repo that the user just have to clone in order to make the tutorial. Because it might be confusing where to create the new directory, since if you make the new diretory inside the bionode-watermill folder it won't work. So, for this PR I will just leave the new example pipeline and the changes in the previous pipeline, to reduce the download size from NCBI. The rest of the tutorial I will create a new repo with specific instructions on how to do it.

tiagofilipe12 commented 7 years ago

I have removed the tutorials and created a new repo for the tutorial. So, here I just left the new pipeline example a minor change to .gitignore and some minor fixes to the variant-calling-filtered.