Skip to content

Commit

Permalink
update merge screenshot (some more) and text
Browse files Browse the repository at this point in the history
  • Loading branch information
MalikaIhle committed May 28, 2024
1 parent de7969a commit baadcc6
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 7 deletions.
Binary file added assets/comment-and-merge.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/files-changed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 33 additions & 7 deletions merge.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,54 @@

***

**If the session is live**: check to see your collaborator's response to your request. Most likely it will be a thumbs up and result in a merge! But your collaborator might also request a correction if they spot an error.
**!!! If the session is live!!! **: go see your collaborator merge your pull request! Most likely it will be a thumbs up and result in a merge! But your collaborator might also request a correction if they spot an error.

**If you are following this tutorial on your own**: you can see a recording of the merge on GitHub here:

<br />


1. **Collaborator's screen**: Once all parameters are collated, look out for the results on your collaborator/instructor's screen. After inspecting and accepting your pull requests (in the pull request tab in their GitHub repository), they will pull their GitHub repository into their local repository.

**If you are following this tutorial on your own asynchronously**: These are the steps of the merge:

<br />

1. **Collaborator's screen - GitHub**: In their pull request tab, they will inspect the files you changed and ensure that the parameters were inputted correctly so as to not break down their code down the line.

![](./assets/files-changed.png)

<br />

2. **Collaborator's screen - GitHub**: They will navigate back to the conversation tab of your pull request to write some comments, merge your pull request, and confirm the merge.

![](./assets/comment-and-merge.png)

<br />

3. **Collaborator's screen - RStudio**: They will pull their GitHub repository into their local repository.

![](./assets/pull.png)

2. **Collaborator's screen**: They will knit the Rmarkdown file `plot-trait-evolution.Rmd` which sources all the contributed files. Knitting a Rmarkdown file means rendering the Rmarkdown code (that integrate R code and Markdown code) into a defined format, here a html file. This file generates plots and figures based on the parameters that were contributed.
<br />


4. **Collaborator's screen - RStudio**: They will knit the Rmarkdown file `plot-trait-evolution.Rmd` which sources all the contributed files. Knitting a Rmarkdown file means rendering the Rmarkdown code (that integrate R code and Markdown code) into a defined format, here a html file. This file generates plots and figures based on the parameters that were contributed.

![](./assets/knit.png)

3. **Collaborator's screen**: If all packages needed to run this script and to knit the file into a html page are installed, this file will generate plots and figures based on the parameters that were contributed.
<br />


5. **Collaborator's screen - RStudio**: If all packages needed to run this script and to knit the file into a html page are installed, this file will generate plots and figures based on the parameters that were contributed.

![](./assets/plot.png)
![](./assets/skulls.png)

If the session is asynchronous:

You can see the full result of a previous session [here](https://rpubs.com/annakrystalli/278074).

<br />

This is how one can integrate data and code to a common repository shared amongst collaborators!


***

Expand Down

0 comments on commit baadcc6

Please sign in to comment.