forked from CRIStAL-PADR/reproducible-research-SE-notes
-
Notifications
You must be signed in to change notification settings - Fork 1
/
workflows.pillar
19 lines (11 loc) · 1.24 KB
/
workflows.pillar
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
!! Workflows for researchers (10% Remi, Guillaume)
In this section, we detail example workflows for researchers.
!!! Having private/public remotes
!!! Writing a scientific paper
In that case, your repository contains at least the source text of the paper, and typically also includes figures. As always, it is advised not to include final products such as pdfs in your repository, only source material that allows any user to produce the outputs himself.
You can use GitHub versions to mark important steps in the writing of your paper. For researchers, this typically means labeling the version of the paper that was submitted to an outlet, the version that was accepted, and the camera-ready version.
You can also link a version of the paper with other material: code, a submission on another platform like ArXiv, a demo.
Since papers and supplementary material now tend to spend some time online and undergo changes before a final version is printed or permanently stored by journals, it becomes important to label each version of the paper and its material correctly, so that the community can refer to specific versions when commenting on your research.
!!! Packaging scientific code
!!! Putting it all together: a reproducible paper
!!! Excercises (Guille 0%)