Primeiros passos utilizando o Git e GitHub no RStudio

class: center, middle, inverse, title-slide

# Primeiros passos utilizando o Git e GitHub no RStudio
## Acesse: <strong>bit.ly/rladiesGit</strong>
### Beatriz Milz
### R-Ladies São Paulo
### 12/09/2019

---

layout: false
class: split-33 with-border

.column.bg-main3[.content.vmiddle[
.center[
# Beatriz Milz
]
<br><br>
<img src="img/bea.jpg" width="90%" style="display: block; margin: auto;" />

]]
.column[.content[

- Doutoranda no Programa de Pós-Graduação em Ciência Ambiental (PROCAM) - Instituto de Energia e Ambiente - Universidade de São Paulo

- Bolsita FAPESP - Processo nº 2018/23771-6 
  
  - Projeto Temático FAPESP Macroamb - Processo nº 2015/03804-9 
  
<img src="img/logos_bia.png" width="50%" style="display: block; margin: auto;" />

- Equipe da Secretaria Executiva  Editorial - [Revista Ambiente & Sociedade](http://scielo.br/asoc)

- Co-organizadora - [R-Ladies São Paulo](https://www.meetup.com/pt-BR/R-Ladies-Sao-Paulo) 💜

- [Currículo disponível neste link](https://beatrizmilz.github.io/resume/index.pdf)

- Blog e slides: [beatrizmilz.com](https://beatrizmilz.com/)

- Anteriormente:
  - Mestre em Ciências - UNIFESP
  - Bacharel em Gestão Ambiental - EACH/USP

]]
---
class: middle

---
class: middle

<img src="https://media1.giphy.com/media/qvWavuCEwjEPu/giphy.gif" width="100%" style="display: block; margin: auto;" />
---
class: middle  bg-main4

# Referências

- Parte deste material foi baseado/inspirado neste post do blog da [Curso-R](https://www.curso-r.com/), escrito por [Caio Lente](https://lente.dev/):
  - [Git e GitHub (Zen do R - Parte 4)](https://www.curso-r.com/blog/2019-07-23-zen-do-r-4/)
  
- Outra referência importante: [Happy Git and GitHub for the useR - 
Jenny Bryan](https://happygitwithr.com/)

- Documentação do pacote [usethis](https://usethis.r-lib.org/reference/create_package.html)
---
layout: false
class: split-33 with-border

.column.bg-main3[.content.vmiddle[
.center[
# Sobre essa palestra]
<br><br>

- **Objetivo**: Auxiliar nos primeiros passos para utilizar o `Git` e `GitHub` diretamente do `RStudio`.

]]

.column.bg-main1[
  .split-five[
  .row.bg-main1[.content[
  ## Pré-requisitos
  ]]
  .row.bg-main2[.content[
  ##  Configurando o Git
  ]]
  .row.bg-main3[.content[
  ##  Configurando o GitHub
  ]]
  .row.bg-main4[.content[
  ##  Trabalhando com projetos no `RStudio` + `GitHub`
  ]]
  .row.bg-main5[.content[
  ##  Interface gráfica do RStudio - aba `Git`
  ]]
]]

---
layout: false
class: bg-main3 split-30 hide-slide-number

.column[

]
.column.slide-in-right[.content.vmiddle[
.sliderbox.shade_main.pad1[
.font5[Pré-requisitos]
]
]]

---
class: middle
# Pré-requisitos

.pull-left[
## R 
  - [Download neste link](https://cran.r-project.org/)
  - Use a versão mais recente 😉

]

.pull-right[
<img src="img/R_logo.svg.png" width="100%" style="display: block; margin: auto;" />
]

---
class:middle

---
class: middle
# Pré-requisitos

.pull-left[
## RStudio
  - [Download neste link](https://www.rstudio.com/products/rstudio/download/)
  - Use a versão mais recente 😉

]

.pull-right[
<img src="img/rstudio.png" width="100%" style="display: block; margin: auto;" />
]

---
class:middle

---
class: middle
# Pré-requisitos

.pull-left[
## Criar um conta gratuita no GitHub
  - [Neste link](https://github.com/)
  - Caso já tenha, não é preciso criar uma nova conta.
  
  
  - Se for estudante: 
    - [GitHub Student Developer Pack](https://education.github.com/pack) - utiliza email institucional da universidade.
  
]

.pull-right[
<img src="img/github-logo.png" width="100%" style="display: block; margin: auto;" />
]

---
class: middle

# Pré-requisitos

.pull-left[

## Git 
  - [Download neste link](https://git-scm.com/downloads)

]

.pull-right[
<img src="https://git-scm.com/images/logo@2x.png" width="80%" style="display: block; margin: auto;" />

]
---
class:middle

---
class: middle
# Pré-requisitos

.pull-left[
## Pacote [`usethis`](https://usethis.r-lib.org/)

```r
install.packages("usethis")
library(usethis)
```

- Palestra (em inglês) da [Jenny Bryan](https://jennybryan.org/):

.pull-right[
<img src="https://usethis.r-lib.org/reference/figures/logo.png" style="display: block; margin: auto;" />
]

---
layout: false
class: bg-main3 split-30 hide-slide-number

.column[

]
.column.slide-in-right[.content.vmiddle[
.sliderbox.shade_main.pad1[
.font5[.center[Configurando o Git]]
]
]]

---
class: middle
# Configurando o Git

- É necessário fazer apenas uma vez (por computador)!

- Duas possibilidades: no Git, ou no RStudio.

- Informar para o Git seu nome, e email.

- Utilize o mesmo email associado à sua conta do GitHub.

- No RStudio:

```r
usethis::use_git_config(user.name = "Beatriz Milz", # Seu nome
                        user.email = "beatriz.milz@hotmail.com") # Seu email
```

---
class: middle
# Configurando o Git

- No Git:

`$ git config --global user.name "Beatriz Milz"`

`$ git config --global user.email beatriz.milz@hotmail.com`

---
layout: false
class: bg-main3 split-30 hide-slide-number

.column[

]
.column.slide-in-right[.content.vmiddle[
.sliderbox.shade_main.pad1[
.font5[.center[Configurando o GitHub + RStudio]]
]
]]
---
class: middle
# Configurando o GitHub + RStudio

- Criar um novo token no GitHub:

```r
usethis::browse_github_token()
# ✔ Opening URL 'https://github.com/settings/tokens/new?scopes=repo,gist&description=R:GITHUB_PAT'
# ● Call `usethis::edit_r_environ()` to open '.Renviron'.
# ● Store your PAT with a line like:
*#   GITHUB_PAT=xxxyyyzzz
#   [Copied to clipboard]
# ● Make sure '.Renviron' ends with a newline!
```

- Uma página do GitHub irá abrir, com as configurações necessárias. Você pode alterar o nome do token, para saber em qual computador está vinculando. Crie o novo token.

---
class: middle  bg-main4

### Exemplo:

---
- Copie o token gerado:

<img src="img/prints/copy-token.png" width="100%" style="display: block; margin: auto;" />
---
- Abra o arquivo `.Renviron`:

```r
usethis::edit_r_environ()
# ● Modify 'C:/Users/beatr/Documents/.Renviron'
# ● Restart R for changes to take effect
```

- Crie uma nova linha na forma `GITHUB_PAT=SEU_TOKEN`, adicione o token, pule uma linha e salve o arquivo.
<img src="img/prints/githubpath.png" width="60%" style="display: block; margin: auto;" />
- **Reinicie o RStudio**:  CTRL + SHIFT + F10

---
layout: false
class: bg-main3 split-30 hide-slide-number

.column[

]
.column.slide-in-right[.content.vmiddle[
.sliderbox.shade_main.pad1[
.font5[.center[Trabalhando com projetos no RStudio + GitHub]]
]
]]
---
# Método 1 - Clonando um repositório do GitHub

- Crie um repositório no GitHub, ou abra a página de um repositório já existente.

- No RStudio, crie um novo projeto: File > New Project 
.pull-left[
- Na aba "Create Project", selecione a opção **Version Control**.

<img src="img/prints/proj-version-control-1.PNG" width="100%" style="display: block; margin: auto;" />
]

.pull-right[

- Na aba "Create Project from Version Control", selecione a opção **Git**.
<img src="img/prints/proj-version-control-2.png" width="100%" style="display: block; margin: auto;" />
]

---
- Na aba "Clone Git Repository":
  - **Repository URL**: Cole o link para o repositório
  - **Project directory name**: Após inserir o repository URL, esse campo será preenchido automaticamente.
  - **Create project as subdirectory of**: Selecione o diretório onde você deseja manter sua cópia local do repositório.
<img src="img/prints/proj-version-control-3.png" width="50%" style="display: block; margin: auto;" />

- O **RStudio** irá fazer o clone do repositório, e abrirá um RProj para ele (caso não exista um ainda, será criado).
---

# Método 2 - Criando um repositório novo, diretamente do RStudio

- Vamos usar a função `create_project()` 
  - Cria um projeto `.Rproj`
  - Argumento importante: `path = ` 	É o "caminho" para o diretório (pasta). Se o diretório já existe, é utilizado. Se não existe, é criado. 
  - Cuidado com o nome do projeto, pois será o mesmo nome que será utilizado no repositório. Você não deve usar o nome de algum repositório já existente no seu GitHub.

---
## Criando um projeto
- No meu caso, tenho o hábito de deixar todos os repositórios do GitHub, na pasta `GitHub/`. No exemplo abaixo, dentro da pasta GitHub, criei o projeto chamado Teste-MeetupR. Esse será o nome da pasta criada e posteriormente do repositório no GitHub.

```r
usethis::create_project("GitHub/Teste-MeetupR") 
# ✔ Creating 'GitHub/Teste-MeetupR/'
# ✔ Setting active project to 'C:/Users/beatr/Documents/GitHub/Teste-MeetupR'
# ✔ Creating 'R/'
# ✔ Writing 'Teste-MeetupR.Rproj'
# ✔ Adding '.Rproj.user' to '.gitignore'
# ✔ Opening 'GitHub/Teste-MeetupR/' in new RStudio session
# ✔ Setting active project to '<no active project>'
```
- O RStudio abrirá outra janela, com o novo projeto criado.
---
## Novo projeto criado!

- Projeto ✔️

- Git ❌

- GitHub ❌

---

```r
usethis::use_git()
# ✔ Setting active project to 'C:/Users/beatr/Documents/GitHub/Teste-MeetupR'
# ✔ Initialising Git repo
# ✔ Adding '.Rhistory', '.RData' to '.gitignore'
# There are 2 uncommitted files:
# * '.gitignore'
# * 'Teste-MeetupR.Rproj'
# Is it ok to commit them?
# 
*# 1: Absolutely  
# 2: Negative
# 3: No
# 
# Selection: 1
# ✔ Adding files
# ✔ Commit with message 'Initial commit'
# ● A restart of RStudio is required to activate the Git pane
# Restart now?
# 
# 1: No way
*# 2: For sure
# 3: Negative
# 
# Selection: 2
```

- O RStudio irá reiniciar para que apareça o painel do Git
---
## Usando Git

- Projeto ✔️

- Git ✔️

- GitHub ❌

---

```r
usethis::use_github()
# ✔ Setting active project to 'C:/Users/beatr/Documents/GitHub/Teste-MeetupR'
# ✔ Checking that current branch is 'master'
# Which git protocol to use? (enter 0 to exit) 
# 
# 1: ssh   <-- presumes that you have set up ssh keys
*# 2: https <-- choose this if you don't have ssh keys (or don't know if you do)
# 
# Selection: 2
# ● Tip: To suppress this menu in future, put
#   `options(usethis.protocol = "https")`
#   in your script or in a user- or project-level startup file, '.Rprofile'.
#   Call `usethis::edit_r_profile()` to open it for editing.
# ● Check title and description
#   Name:        Teste-MeetupR
#   Description: 
# Are title and description ok?
# 
# 1: No way
*# 2: Definitely
# 3: Nope
# 
# Selection: 2
# ✔ Creating GitHub repository
# ✔ Setting remote 'origin' to 'https://github.com/beatrizmilz/Teste-MeetupR.git'
# ✔ Pushing 'master' branch to GitHub and setting remote tracking branch
# ✔ Opening URL 'https://github.com/beatrizmilz/Teste-MeetupR'
```

---
## Repositório criado!

- Projeto ✔️

- Git ✔️

- GitHub ✔️

---

## Função para criar um arquivo `README.md`

```r
usethis::use_readme_md()
```
- O arquivo será criado e aberto, para ser editado e salvo.

---
class: middle  bg-main4

### Exemplo:

---

# Método 3 - A partir de um repositório existente, fazer um fork e clonar diretamente do RStudio

- Para isso, usaremos a função `usethis::create_from_github()`.
- Argumentos importantes:
  - `repo_spec = ` repositório que quer trabalhar. Deve estar no formato: "usuario_github/repositorio". Veja o exemplo abaixo.
  - `destdir =` diretório onde quer que os arquivos sejam salvos
  - `fork =` se igual a TRUE, irá fazer o fork do repositório. Só funcionará se o token do GitHub foi configurado corretamente.

---
### Exemplo do uso da função `create_from_github()`
- Exemplo: fork e clone do projeto [Data Science in a Box](https://github.com/rstudio-education/datascience-box/):

https://github.com/rstudio-education/datascience-box/

```r
usethis::create_from_github("rstudio-education/datascience-box",
                   destdir = "C:/Users/beatr/Documents/GitHub", 
                   fork = TRUE)
# ✔ Creating 'C:/Users/beatr/Documents/GitHub/datascience-box/'
# ✔ Forking 'rstudio-education/datascience-box'
# ✔ Cloning repo from 'https://github.com/beatrizmilz/datascience-box.git' into 'C:/Users/beatr/Documents/GitHub/datascience-box'
# ✔ Setting active project to 'C:/Users/beatr/Documents/GitHub/datascience-box'
# ✔ Adding 'upstream' remote: 'https://github.com/rstudio-education/datascience-box.git'
# ✔ Pulling changes from GitHub source repo 'upstream/master'
# ✔ Setting remote tracking branch for local 'master' branch to 'upstream/master'
# ✔ Opening 'C:/Users/beatr/Documents/GitHub/datascience-box/' in new RStudio session
# ✔ Setting active project to 'C:/Users/beatr/Documents/GitHub/RLadies-Git-RStudio-2019'
```

---
## Crie um branch

- Antes de fazer qualquer modificação, crie uma branch, usando a função `usethis::pr_init()`. 
- Argumento importante: `branch =` indica o nome da branch que você quer criar.

```r
usethis::pr_init(branch = "teste")

# ✔ Checking that local branch 'master' has the changes in 'origin/master'
# ✔ Creating local PR branch 'teste'
# ✔ Switching to branch 'teste'
# ● Use `pr_push()` to create PR
```

- Faça suas contribuições, e sempre faça commits com mensagens que deixem claro as mudanças.

- Quando terminar as contribuições necessárias, utilizar a função `pr_push()`:

```r
pr_push()
# ✔ Pushing local 'teste' branch to 'origin:teste'
# ✔ Setting upstream tracking branch for 'teste' to 'origin/teste'
# ✔ Create PR at link given below
# ✔ Opening URL 'https://github.com/beatrizmilz/RLadies-Git-RStudio-2019/compare/teste'
```

- A página do GitHub será aberta, para que possa completar o Pull Request.
---
class: middle

## Crie um Pull Request: 
<img src="img/prints/pr-push.PNG" width="80%" style="display: block; margin: auto;" />

---
class: middle

## Open a Pull Request: 
<img src="img/prints/pr-push2.png" width="80%" style="display: block; margin: auto;" />

---
class: middle

## Exemplo: PR foi aberto
<img src="img/prints/pr-push3.png" width="80%" style="display: block; margin: auto;" />

- Depois dessa etapa, você deve esperar o mantenedor do repositório responder aceitando seu PR, fazendo sujestões para melhorias, etc.
---
class: middle

## Depois que o PR é aceito:  Merged

---
class: middle

## Última etapa: voltar para a master, atualizar (pull) o conteúdo e deletar a branch criada

```r
pr_finish()
# ✔ Switching back to 'master' branch
# ✔ Pulling changes from GitHub source repo 'origin/master'
# ✔ Deleting local 'teste' branch
```

- Pronto!

---
layout: false
class: bg-main3 split-30 hide-slide-number

.column[

]
.column.slide-in-right[.content.vmiddle[
.sliderbox.shade_main.pad1[
.font5[.center[Interface gráfica do RStudio]]
]
]]
---
class: middle

## Interface Gráfica RStudio

- O RStudio oferece um cliente Git **simples**, na aba "Git" (em inglês, é chamado de Git Pane).

- Esse painel somente aparecerá em projetos que estejam versionados com Git.

<img src="img/prints/git-pane.PNG" width="95%" style="display: block; margin: auto;" />
---
class: middle

## Interface Gráfica RStudio

Fonte: [RStudio Cheatsheet](https://www.rstudio.com/wp-content/uploads/2019/01/Cheatsheets_2019.pdf)
---
class: middle

## Branch

<img src="img/prints/git-pane-branch.png" width="960" style="display: block; margin: auto;" />
---
class: middle

## Botão Diff -> Review changes

---
class: middle

## Botão 🕒 (history) -> Review changes

---
class: middle

## Git pane - Staged  ✅

---
class: middle

## Git pane - Commit

---
class: middle

## Git pane - Commit

---
class: center, middle

## Linha de comando ou interface gráfica?
## Use o que for melhor para **você**!

Confira a [cheatsheet do Git](https://github.github.com/training-kit/downloads/pt_BR/github-git-cheat-sheet.pdf)!

---
class:  middle

# Check-list da configuração!

## Para o tempo restante (ou para 🏠)

1) Verifique se você tem instalado no seu computador: R, RStudio e Git.

2) Caso não esteja configurado, configure o Git: conte para ele seu nome e seu email 😃

3) No RStudio, verifique se você tem o pacote `usethis` instalado. Caso não esteja instalado, instale. Utilize a função `library(usethis)` para deixar a função `usethis` disponível para uso.

4) No RStudio, configure o GitHub token.

- Caso encontre algum erro no caminho, **[submeta uma issue neste repositório](https://github.com/beatrizmilz/RLadies-Git-RStudio-2019/issues/new)** para que o material seja aprimorado. 
---
class:  middle

# Práticas!

## Para o tempo restante (ou para 🏠)

1) Utilizando o método 1, clone um repositório que deseja que esteja disponível localmente (escolha um repositório leve).

2) Utilizando o método 2, crie um novo repositório diretamente do RStudio, para testar.

3) Utilizando o método 3, faça um fork do repositório desta apresentação. No arquivo `README.md`, existe a seção participantes. Adicione uma nova linha com o seu nome, e algum link de uma página sua (pode ser blog, Twitter, Linkedin, GitHub, etc). Faça um pull request 😃.
    - Dica: use no primeiro argumento (`repo_spec = `) o repositório  "beatrizmilz/RLadies-Git-RStudio-2019"

- Caso encontre algum erro no caminho, **[submeta uma issue neste repositório](https://github.com/beatrizmilz/RLadies-Git-RStudio-2019/issues/new)** para que o material seja aprimorado.

---
class:  middle bg-black white
# Preparadas para a Hacktoberfest 2019? 
## 
https://hacktoberfest.digitalocean.com/

---
class: middle  bg-main4

# Referências

- Documentação do pacote [usethis](https://usethis.r-lib.org/reference/create_package.html)

---
class: middle

# Agradecimentos

.pull-left[

- **Contato**:

- Email: <a href="mailto:beatriz.milz@usp.br">beatriz.milz@usp.br</a>
  - Webpage: https://beatrizmilz.com
  - Github: <a href="http://github.com/beatrizmilz">@beatrizmilz</a>
  - Twitter: <a href="http://twitter.com/beatrizmilz">@BeaMilz</a> 
  - Linkedin: <a href="https://www.linkedin.com/in/beatrizmilz">Beatriz Milz</a>
]

.pull-right[
**Agradecimentos especiais**:
- **Participantes da R-Ladies São Paulo**
- [Haydee Svab](https://www.linkedin.com/in/hsvab/) e [Angélica Custódio](https://www.linkedin.com/in/angelicacustodio/)
- [Caio Lente](https://github.com/clente) e [Curso-R](https://www.curso-r.com/) - Pelo post sobre Git e GitHub, e por responder as dúvidas!

- Apresentação feita com [Xaringan](https://github.com/yihui/xaringan) e [Kunoichi](https://github.com/emitanaka/ninja-theme).
]