-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathreleasing.Rmd
61 lines (37 loc) · 5 KB
/
releasing.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
---
title: "Releasing"
author: "Gabriel Nakamura"
date: "`r Sys.Date()`"
output: html_document
---
# Um retrato permanente do seu projeto
Aquela bela mensagem que todos nós gostamos de receber: "Parabéns, seu artigo foi aceito para publicação na revista XXXXX". Trabalho terminado, certo? É hora de encaixotar tudo e partir para outra empreitada científica? Não! Antes disso precisamos registar nosso código de modo que ele possa ser rastreado facilmente, citado e, acima de tudo, reproduzível de modo que quem o faça chegue nas mesmas conclusões que chegamos em nosso artigo. Porém, seu código está no GitHub, e volta e meia ele é modificado, ou por algum motivo técnico, instabilidade de servidor ou até mesmo porque você decidiu revisitá-lo e modificar um pouco esse código. A questão é, como fazer com que seu código possa ser registrado e guardado com segurança e de maneira permanente? Para isso utilizamos algum repositório para armazenamento permanente.
Aqui irei mostrar como isso pode ser feita a partir da utilização do [Zenodo](https://zenodo.org/), mas outros repositórios permanentes de dados e códigos estão disponíveis por aí, por exemplo Dryad.
Para armazenar seu código no Zenodo, a primeira coisa a ser feita é criar uma conta nele. A minha sugestão é que esta conta seja criada através da sua conta do GitHub, isso faz com que o Zenodo já tenha conexão com seus repositórios, incluindo aquele que pretende fazer o armazenamento permanente.
# Acessando seus repositórios via Zenodo
Para ver os seus repositórios através do Zenodo basta acessar a aba GitHub via zenodo, como mostrado na seta da Figura abaixo
```{r echo=FALSE, eval=TRUE, fig.cap="Página do zenodo que apresenta conexão com seus repositórios no Github"}
knitr::include_graphics("figs/zenodo-page.png")
```
Ao acessar a aba GitHub via Zenodo, todos os seus repositórios públicos irão aparecer, portanto, é importante que o repositório que você pretende fazer o armazenamento permanente dos dados seja público, como mostrado na imagem abaixo
```{r echo=FALSE, eval=TRUE, fig.cap="Página do zenodo com seus repositórios públicos Github"}
knitr::include_graphics("figs/zenodo2.png")
```
O primeiro passo é habilitar o acesso do Zenodo ao repositório de interesse. Como mostrado na própria página do Zenodo. Em seguida você deve fazer um **release** do seu repositório, mas o que é isso? Como o próprio nome diz, o release é um lançamento do repositório, é como se fosse uma fotografia do repositório inteiro em um dado momento. Fazemos isso, por exemplo, quando temos uma versão estável de um pacote estatístico, ou quando submetemos o nosso manuscrito para uma revista ou repositórios de preprints. O release é importante pois é a partir dele que será criado o DOI (Digital Object Identifier), que é como um RG do seu repositório, um número único pelo qual ele pode ser identificado na internet.
Para criar um release clique no botão verde na figura seguinte. Ele te redicionará para a página do GitHub.
```{r echo=FALSE, eval=TRUE, fig.cap="Página do zenodo que redicionará para o github para criar o release"}
knitr::include_graphics("figs/zenodo3.png")
```
Ná página do GitHub dê um nome para esse seu novo release. Geralmente os nomes seguem um formato com três digitos separados por pontos, chamamos esse sistema de [versionamento semântico](https://semver.org/lang/pt-BR/) e utilizamos ele para controlar as versões de lançamento de acordo com mudanças que podemos ir fazendo no nosso código. Isso é mais comum de ser utilizado para controlar versões de pacotes, mas não impede que utilize a mesma lógica no seu repositório que contém dados e códigos de análises.
Para lançar seu release basta atribuir um nome de versão para seu repositório e pronto! Basta clicar no botão para publicar o release e ele está pronto.
```{r echo=FALSE, eval=TRUE, fig.cap="Página do github para preencher as informações do release"}
knitr::include_graphics("figs/zenodo4.png")
```
Após isso, volte para a página do Zenodo, lá você vai encontrar algumas coisas novas ao clicar no repositório que fez o release, a mais importante dela será o DOI.
```{r echo=FALSE, eval=TRUE, fig.cap="Página do Zenodo mostrando as informações do release, com destaque para o DOI"}
knitr::include_graphics("figs/zenodo5.png")
```
Esse número, a partir de agora, identificará seu repositório no Zenodo. Você pode, por exemplo, adicionar esse número no seu README, de modo que quem acesse o seu repositório através do GitHub saiba que você tem uma versão de armazenamento permanente que pode ser acessada através desse DOI no sítio do Zenodo. Este número também pode ser adicionado na versão final do seu artigo, juntamente com o endereço eletrônico para o repositório no Zenodo. Abaixo veja as informações adequadas para diferentes tipos de documentos e situações
```{r echo=FALSE, eval=TRUE, fig.cap="Página do Zenodo mostrando as informações do release"}
knitr::include_graphics("figs/zenodo6.png")
```