Skip to content

Commit f6ab4b2

Browse files
authored
Merge pull request #103 from SPAAM-community/gitghub-morexamples
Give more context why archiving can be useful
2 parents 020880f + fc886f2 commit f6ab4b2

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

git-github.qmd

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,19 @@ So why should you use a version control system, such as GitHub?
5555
4. Allow you to test new scripts or code before updating a public version in a 'sandbox' area of the repository
5656
5. Help share our data, code, and results with the world!
5757

58+
:::{.callout-tip}
59+
It's not just for reproducible code that sharing things on places like GitHub can be useful!
60+
61+
You can use (well-archived) Git repositories to 'get around' publisher limits when it comes to things such as supplementary files in publications!
62+
63+
For example, in addition to code and scripts, I have previously used a GitHub repository to host additional supplementary figures, methods descriptions, and tables.
64+
You can see this here: [https://github.com/jfy133/Hominid_Calculus_Microbiome_Evolution](https://github.com/jfy133/Hominid_Calculus_Microbiome_Evolution).
65+
66+
Furthermore, by including and describing them alongside with my code, it makes it much easier (and searchable) for other researchers to find out exactly how I did things!
67+
68+
The important thing is to archive the repository on places like Zenodo ([https://zenodo.org/](https://zenodo.org/)), to ensure longevity alongside the publication, and cite the archive DOI in your main manuscript. The corresponding Zenodo DOI for the repository above is: [https://zenodo.org/doi/10.5281/zenodo.3740492](https://zenodo.org/doi/10.5281/zenodo.3740492).
69+
:::
70+
5871
## Basic workflow
5972

6073
The basic concepts of using git and GitHub are as shown in (@fig-gitgithub-workflowdiagram)

0 commit comments

Comments
 (0)