From 1ba0d956df35f85165cbb4343f38fd1398af69a9 Mon Sep 17 00:00:00 2001 From: camilavargasp Date: Tue, 30 Apr 2024 10:11:11 -0600 Subject: [PATCH] adding qmd with info on how to install R and git in personal computer --- materials/_quarto.yml | 2 +- materials/sections/r-git-install-guide.qmd | 179 +++++++++++++++++++++ materials/session_16.qmd | 5 +- 3 files changed, 183 insertions(+), 3 deletions(-) create mode 100644 materials/sections/r-git-install-guide.qmd diff --git a/materials/_quarto.yml b/materials/_quarto.yml index 54a26d9c..bf8a604c 100755 --- a/materials/_quarto.yml +++ b/materials/_quarto.yml @@ -42,7 +42,7 @@ book: - session_13.qmd # Spatial Data - session_14.qmd # Shiny - session_15.qmd # Reproducibility and Provenence - # - session_16.qmd # Appendix: Set up in personla comp + - session_16.qmd # Appendix: Set up in personla comp # - session_17.qmd # Practice Session II # - session_18.qmd # Data Portals # - session_19.qmd # Spatial Data diff --git a/materials/sections/r-git-install-guide.qmd b/materials/sections/r-git-install-guide.qmd new file mode 100644 index 00000000..b9bd5572 --- /dev/null +++ b/materials/sections/r-git-install-guide.qmd @@ -0,0 +1,179 @@ + +## Installation steps for MacOS + +### Install or update R + +To install R, visit [cloud.r-project.org](https://cloud.r-project.org/) to download the most recent version for your operating system. The latest release is version 4.3.2 ( released 2023-10-31). + +### Install or update RStudio + +While R is a programming language, RStudio is a software (often referred to as an IDE, **I**ntegrated **D**evelopment **E**nvironment) that provides R programmers with a neat, easy-to-use interface for coding in R. There are a number of IDEs out there, but RStudio is arguably the best and definitely most popular among R programmers. + +**Note:** RStudio will not work without R installed, and you won't particularly enjoy using R without having RStudio installed. Be sure to install *both*! + +```{r, echo = FALSE, fig.align="center", fig.cap = "Image Credit: Manny Gimond | Accessible at https://mgimond.github.io/ES218/R_vs_RStudio.html"} +knitr::include_graphics("images/R_RStudio.png") +``` + +- **New install:** To install RStudio, visit . Download the free (“Open Source Edition”) Desktop version for your operating system. You should install the most up-to-date version available that is supported by your operating system. + +- **Update:** If you already have RStudio and need to update: Open RStudio, and under ‘Help’ in the top menu, choose ‘Check for updates.’ If you have the most recent release, it will return ‘No update available. You are running the most recent version of RStudio.’ Otherwise, you should follow the instructions to install an updated version. + +- Open RStudio (logo you'll click on shown below): **If upon opening RStudio you are prompted to install Command Line Tools, do it.** + +```{r, echo = FALSE, fig.out="10%", fig.align="center"} +knitr::include_graphics("images/rstudio-logo.png") +``` + +- Note: you may need to install command line tools and XQuartz. + + - To install command line tools (if you’re not automatically prompted), run in the Terminal tab in RStudio: `xcode-select --install` + - Visit [xquartz.org](https://www.xquartz.org/) to download & install XQuartz + +### Install Quarto + +Quarto is a scientific publishing tool built on Pandoc that allows R, Python, Julia, and ObservableJS users to create dynamic documents, websites, books and more. + +Quarto is now included with RStudio v2022.07.1+ **so no need for a separate download/install** if you have the latest version of RStudio! You can find all releases (current, pre, and older releases) on the Quarto website [download page](https://quarto.org/docs/download/), should you want/need to reference them. + +### Check for git + +You should already have git on your device, but let’s check for it anyway. + +- Open RStudio + +- In the Terminal, run the following command: + +```{bash eval=FALSE} +which git +``` + +- If after running that you get something that looks like a file path to git on your computer, then you have git installed. For example, that might return something like this (or it could differ a bit): `/usr/local/bin/git`. If you instead get no response at all, you should download & install git from here: [git-scm.com/downloads](https://git-scm.com/downloads) + +**An aside:** Is it ncesary to have Git installed in your machine for this workshop. GitHub's [Git Guides](https://github.com/git-guides) are a really wonderful resource to start learning about this topic. + + + +### Install R packages + +- Install the `usethis` and `gitcreds` packages in R by running the following in the RStudio Console: + +```{r eval=FALSE} +install.packages(“usethis”) + +install.packages("gitcreds") +``` + +A lot of scary looking red text will show up while this is installing - don’t panic. If you get to the end and see something like below (with no error) it’s installed successfully. + +```{r, echo = FALSE, fig.out="60%", fig.align="center"} +knitr::include_graphics("images/install-pkg-success.png") +``` + + +### Create a GitHub account + +- If you don’t already have a GitHub account, go to [github](https://github.com/).com and create one. Here are helpful considerations for choosing a username: [happygitwithr.com/github-acct.html](https://happygitwithr.com/github-acct.html). + + +**Once you've completed these steps you are ready for our workshop on Git and Github** + + + + +## Installation steps for Windows + +### Install or update R + +To install R, visit [cloud.r-project.org](https://cloud.r-project.org/) to download the most recent version for your operating system. The latest release is version 4.3.2 ( released 2023-10-31). + +### Install or update RStudio + +While R is a programming language, RStudio is a software (often referred to as an IDE, **I**ntegrated **D**evelopment **E**nvironment) that provides R programmers with a neat, easy-to-use interface for coding in R. There are a number of IDEs out there, but RStudio is arguably the best and definitely most popular among R programmers. + +**Note:** RStudio will not work without R installed, and you won't particularly enjoy using R without having RStudio installed. Be sure to install *both*! + +```{r, echo = FALSE, fig.align="center", fig.cap = "Image Credit: Manny Gimond | Accessible at https://mgimond.github.io/ES218/R_vs_RStudio.html"} +knitr::include_graphics("images/R_RStudio.png") +``` + +- **New install:** To install RStudio, visit . Download the free (“Open Source Edition”) Desktop version for your operating system. You should install the most up-to-date version available that is supported by your operating system. + +- **Update:** If you already have RStudio and need to update: Open RStudio, and under ‘Help’ in the top menu, choose ‘Check for updates.’ If you have the most recent release, it will return ‘No update available. You are running the most recent version of RStudio.’ Otherwise, you should follow the instructions to install an updated version. + +- Open RStudio (logo you'll click on shown below): **If upon opening RStudio you are prompted to install Command Line Tools, do it.** + +```{r, echo = FALSE, fig.out="10%", fig.align="center"} +knitr::include_graphics("images/rstudio-logo.png") +``` + + +### Install Quarto + +Quarto is a scientific publishing tool built on Pandoc that allows R, Python, Julia, and ObservableJS users to create dynamic documents, websites, books and more. + +Quarto is now included with RStudio v2022.07.1+ **so no need for a separate download/install** if you have the latest version of RStudio! You can find all releases (current, pre, and older releases) on the Quarto website [download page](https://quarto.org/docs/download/), should you want/need to reference them. + +### Check for git + +You should already have git on your device, but let’s check for it anyway. + +- Open RStudio + +- In the Terminal, run the following command: + +```{bash eval=FALSE} +where git +``` + +- If after running that you get something that looks like a file path to git on your computer, then you have git installed. For example, that might return something like this (or it could differ a bit): `/usr/local/bin/git`. If you instead get no response at all or something along the lines "git is not installed", you should download & install git from here: . + +Once you have download and installed Git, restart your computer. Then open RStudio and again run: + +```{bash eval=FALSE} +where git +``` + +If you still get a message saying something like "git is not installed", check out the [Troubleshooting](/session_04.html#troubleshooting) section below. + +**An aside:** Is it necessary to have Git installed in your machine for this workshop. GitHub's [Git Guides](https://github.com/git-guides) are a really wonderful resource to start learning about this topic. + + + +### Install R packages + +- Install the `usethis` and `gitcreds` packages in R by running the following in the RStudio Console: + +```{r eval=FALSE} +install.packages("usethis") + +install.packages("gitcreds") +``` + +A lot of scary looking red text will show up while this is installing - don’t panic. If you get to the end and see something like below (with no error) it’s installed successfully. + +```{r, echo = FALSE, fig.out="60%", fig.align="center"} +knitr::include_graphics("images/install-pkg-success.png") +``` + + +### Create a GitHub account + +- If you don’t already have a GitHub account, go to [github.com](https://github.com/) and create one. Here are helpful considerations for choosing a username: [happygitwithr.com/github-acct.html](https://happygitwithr.com/github-acct.html). + + +**Once you've completed these steps you are ready for our workshop on Git and Github** + +## Troubleshooting + +:::callout-warning +## Issues installing Git on a Windows +If you download Git and the Git commands still not recognized by your computer, check your computer's PATHS. + +To do this, follow the instructions in [this link](https://stackoverflow.com/questions/4492979/error-git-is-not-recognized-as-an-internal-or-external-command) on how to set the right PATHS. + + +Restart your computer and try running `git --version` on the terminal. You should get something like `git version XX.XX` (but with numbers instead of Xs). + +**If you see the git version printed out in your terminal, you are all set** +::: diff --git a/materials/session_16.qmd b/materials/session_16.qmd index 5d5364f3..43731d41 100644 --- a/materials/session_16.qmd +++ b/materials/session_16.qmd @@ -1,7 +1,8 @@ --- -title: "Building R Packages" +title: "Appendix: Install R and Git in your Computer" title-block-banner: true --- +NEED TO FIX IMAGES FILE PATH -{{< include /sections/r-creating-packages.qmd >}} +