Alyssa Goodman edited Rule 4. Publish workflow as context.md  almost 11 years ago

Commit id: 7b4b8446e32557568c4c9dfd87e705860d37c8d3

deletions | additions      

       

# Rule 4. Publish workflow as context.  Traditionally, what computer and information scientists call "workflow" has been captured in what scientists call the "methods" and/or "analysis" section(s) of a scholarly article, where data collection, manipulation, and analysis processes are described. Today, nearly every study uses computer software to carry out the bulk of its workflow, but rarely is the end-to-end process described in a paper captured in just one software package. Thus, while directly publishing code is critical (see Rule 6), publishing a description of your processing steps offers essential context for interpreting and re-using data.  In the future, the most useful workflow documentation will be part of a an electronic  provenance record that "automagically"  links together all the pieces that led to a result: the data citation (Rule 2), the pointer to the code (Rule 6), the workflow (this Rule), and a scholarly paper. Systems that document workflow in a way that they can plug into provenance visions like this one are best, so keep an eye out for such systems in your field. Web services that encapsulate workflow are a good way to reduce the burden of software overhead and dependencies. In life sciences, systems like Taverna and Kepler are good examples (xxrefsxx). Other standardized workflow documentation systems are offered by ``notebooks" within some software packages, such as the Mathematica and iPython notebooks (xxrefsxx). Systems (see Rule 2) that offer hdl and doi identifiers for data can, and do, offer those identifiers for workflow files as well.  At a minimum, a simple sketch of dataflow across software, indicating how intermediate data and final results are generated, and parameter values used in the analysis, should be offered. Keep in mind that even if the data used are not "new," in that they come from a well-documented archive, it is still important to document the archive query that produced the data you used, along with all the operations you performed on the data after they were retrieved.