[Bioc-devel] Workflow Package Updates / Guidelines

[Shepherd, Lori]

As mentioned before the workflows are in git and are now building on our
standard build machines.

The build reports are generated mon, wed, fri and can be seen here
http://bioconductor.org/checkResults/3.7/workflows-LATEST/

Moving forward we want to align how we treat workflows with how we treat the
software and data experiment packages.

Some of this can already be seen on the biocViews section of the website
http://bioconductor.org/packages/devel/BiocViews.html#___Workflow
You'll notice we started adding specific Workflow biocViews terms based on the
categories that were used on the http://bioconductor.org/help/workflows/ page.
We have updated the workflow packages to include appropriate biocViews from this
page as well. The updated biocViews are already updated in the Bioconductor
git.bioconductor.org repositories and should be reflected on the website after
monday's build of the workflows. If anyone thinks additional workflow views
would be helpful please email lori.shepherd at roswellpark.org or post for
discussion on our community workflow slack feed
https://community-bioc.slack.com/messages/CA17HQDGE/convo/CA17HQDGE-1522768000.000477/


 Eventually, the http://bioconductor.org/help/workflows/ will be retired, as the
 workflows now have a standard landing page (linked off the biocViews page
 above). We will be adding redirects internally to hopefully protect any
 existing links in papers and such.

 Moving forward we will have a few additional requires for the  vignettes of
 workflow packages.  Namely that the  vignette has a meaningful name  and that
 it uses BiocStyle for formatting. This is an effort to standardize the
 workflows. Currently we will enforce  BiocStyle::html_document.  We are in  the
 works of developing a html_workflow_template. We encourage any vignettes that
 are not using this BiocStyle format to update the workflow vignette as soon as
 possible - eventually this update will be required.

Keep in mind also - that a proper version bump will be needed to trigger build
and propagation of workflows. And since the workflows will be building on
release and devel they should follow the similar guidelines regarding versioning
http://bioconductor.org/developers/how-to/version-numbering/

We welcome any feedback

Cheers,




Lori Shepherd

Bioconductor Core Team

Roswell Park Cancer Institute

Department of Biostatistics & Bioinformatics

Elm & Carlton Streets

Buffalo, New York 14263


This email message may contain legally privileged and/or confidential information.  If you are not the intended recipient(s), or the employee or agent responsible for the delivery of this message to the intended recipient(s), you are hereby notified that any disclosure, copying, distribution, or use of this email message is prohibited.  If you have received this message in error, please notify the sender immediately by e-mail and delete this email message from your computer. Thank you.
	[[alternative HTML version deleted]]