Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use established software package repositories (bioconductor, bioconda) and provide comprehensive documentation (including vignettes/tutorials) #14

Open
enricoferrero opened this issue Jul 26, 2019 · 3 comments
Labels
Rule Discussing possible rule

Comments

@enricoferrero
Copy link

The bioinformatics community has assembled some great software package repositories such as Bioconductor and Bioconda (and probably others I'm not aware of).
Scientists who create new tools should try, where possible, to release them as part of these framework to increase ease of access, interoperability and benchmarking.

Related to this, software documentation is of paramount importance. Aside from the obvious requirement of a manual, developers should also aim to provide vignettes/tutorials for the most common use cases. IIRC this is enforced in submissions to Bioconductor.

@enricoferrero enricoferrero added the Rule Discussing possible rule label Jul 26, 2019
@gwaybio
Copy link
Member

gwaybio commented Jul 26, 2019

Yeah this is great. I think of this rule as under some sort of reproducibility umbrella.

Open science is only as good as the "science" part - and good science requires reproducibile practices!

@gwaybio
Copy link
Member

gwaybio commented Jul 26, 2019

We can also use this rule to link out to other reproducibility papers that will cover this topic comprehensively.

@gwaybio
Copy link
Member

gwaybio commented Aug 1, 2019

A couple related blogposts mentioned in #11 - essentially, open science practice follows from open data repositories with effective annotations and computational tools with reproducible workflows - all pursued in a version controlled environment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Rule Discussing possible rule
Projects
None yet
Development

No branches or pull requests

2 participants