Difference between revisions of "Document provenance of results by Allen Pope"

Revision as of 18:28, 12 March 2015

Details on how to do this task: Document the provenance of the results

I looked through the workflow tools. They look good in theory, but with code already done, it was too much of a hassle. Also, not used by my community so not as helpful. So, I have chosen to created a fairly detailed workflow diagram, instead (I chose to do this in Illustrator).

This was a good exercise to align datasets and code. It made sure that I knew all the bits of code I needed (was good to do before sharing code - now that is ready to do, too) as well as all the data. Gave me an appreciation for the complexity behind what is otherwise a fairly simple description.

I think it will potentially make easier for others to use. It also made me realize my code is probably not terribly efficient. Something to work on better in the future, not necessarily now. I also realized that putting together this structure helped me change the way I think about blocks of code, etc - which will be helpful for sharing code later.

As a not-formally-trained coder, this made me realize more best practice in terms of creating code.