pepkit / caravel

A web GUI for pipeline job submission and management
http://caravel.databio.org
BSD 2-Clause "Simplified" License
5 stars 1 forks source link

what's the example? #127

Closed nsheff closed 5 years ago

nsheff commented 5 years ago

the docs say: caravel -c example_config.yaml

the master branch has an example called "example_caravel.yaml"

the dev branch has no example anymore.

what/where is the example supposed to be and can we please standardize the docs and repositories so that there is a functioning example?

nsheff commented 5 years ago

Ok I think see -- on dev I should use caravel --demo ... but wouldn't it be good to also have an example config file to show?

nsheff commented 5 years ago

actually this is fine for now. I understand where you're going.

I think eventually if we adjust the projects config file we should explicitly show it (in addition or seprately from the --demo thing which is pretty nice.