Skip to content

H-Mateus/spinal-studies-rjah-site

Repository files navigation

Readme

This is the github repo of the OsKOR group website.

Initial setup

Install or upgrade R and RStuido

  1. Install R for your OS from here: https://cloud.r-project.org
  • If you already have R installed you can check if your version is current by running the following from R console:
R.version.string
  1. Install RStudio Desktop for your OS from here: https://www.rstudio.com/products/rstudio/download/#download
  2. Update your R packages from the R console:
update.packages(ask = FALSE, checkBuilt = TRUE)
  1. Install the blogdown package in R:
if (!requireNamespace("remotes")) install.packages("remotes")
remotes::install_github("rstudio/blogdown")

Install and set up Git

  • Make a github account here.
  • Ask the current site admin to be added as a collaborator to the repo.
  • Make sure Git is installed on your machine (guide here)
  • Add your username and email to git: From the shell:
git config --global user.name 'Jane Doe'
git config --global user.email '[email protected]'
git config --global --list

Or from R with the usethis package:

## install if needed (do this exactly once):
## install.packages("usethis")

library(usethis)
use_git_config(user.name = "Jane Doe", user.email = "[email protected]")

Note that your user name doesn't need to be the same as your GitHub user name, though it can be, but your email must be the one associated with your GitHub account. More details can be found here

I would highly recommend following chapters 4-14 of the Happy Git with R book if you are completely new to R and Git.

Cloning the homepage repo

  • Open your terminal and navigate to a directory where you'd like to clone the repository.
  • Run this command in your terminal:
git clone https://github.com/H-Mateus/spinal-studies-rjah-site.git

Install Hugo

This site uses the Hugo static website generator, so you will need to install it.

  • On Linux Hugo is available in most major repositories so you can install from there.
  • On Mac you'll likely want to use homebrew, instructions for which can be found here.
  • On Windows you'll want to stop making bad life choices. If you refuse, there is a docker container or you could use Chocolatey, instructions here.