.. reproducible-research Version Control file, created by ARichards

===========
Audit trail
===========

The importance of documenting you work cannot be overstated.  If we are doing analyses in a reproducible way then we are using code to carry out **all** the data manipulations.  Fortunately for us there exist `version control systems <http://en.wikipedia.org/wiki/Revision_control>`_ to make our lives easier.

The most commonly used version control systems used today are: 

  * `Subversion <http://subversion.tigris.org>`_
  * `Mercurial <http://mercurial.selenic.com>`_
  * `Git <http://git-scm.com>`_

This is by no means a complete list.  Wiki maintains a `more comprehensive list <http://en.wikipedia.org/wiki/List_of_revision_control_software>`_ for those who are interested. Version control systems are software that help us manage documents (i.e. code or manuscripts) that change through time.  They may be used through graphical user interfaces or via the command line.  Although these systems may be installed locally it is more common to see them used along with a place to store the documents.

The most commonly used web-based hosting services for revision control are:

  * `GitHub <https://github.com>`_
  * `Bitbucket <https://bitbucket.org>`_
  * `Google code <https://code.google.com>`_

These services are free and they promote collaboration.  I encourage you to read some of the following resources about version control in scientific research.

  * `Version control for scientific research <http://blogs.biomedcentral.com/bmcblog/2013/02/28/version-control-for-scientific-research>`_
  * `Git can facilitate greater reproducibility and increased transparency in science  <http://www.scfbm.org/content/8/1/7/>`_
  * `Where's the Real Bottleneck in Scientific Computing? <http://www.americanscientist.org/issues/pub/wheres-the-real-bottleneck-in-scientific-computing>`_
  * `Software carpentry's lectures on version control <http://software-carpentry.org/v4/vc/>`_