Skip to content

Commit

Permalink
Merge pull request #103 from SPAAM-community/gitghub-morexamples
Browse files Browse the repository at this point in the history
Give more context why archiving can be useful
  • Loading branch information
jfy133 authored Aug 13, 2024
2 parents 020880f + fc886f2 commit f6ab4b2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions git-github.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,19 @@ So why should you use a version control system, such as GitHub?
4. Allow you to test new scripts or code before updating a public version in a 'sandbox' area of the repository
5. Help share our data, code, and results with the world!

:::{.callout-tip}
It's not just for reproducible code that sharing things on places like GitHub can be useful!

You can use (well-archived) Git repositories to 'get around' publisher limits when it comes to things such as supplementary files in publications!

For example, in addition to code and scripts, I have previously used a GitHub repository to host additional supplementary figures, methods descriptions, and tables.
You can see this here: [https://github.com/jfy133/Hominid_Calculus_Microbiome_Evolution](https://github.com/jfy133/Hominid_Calculus_Microbiome_Evolution).

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!

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).
:::

## Basic workflow

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

0 comments on commit f6ab4b2

Please sign in to comment.