Get Started

Set up your environment to run the GJD R use cases

Prerequisites

Before running any of the examples in this section, make sure you have the following software installed on your machine.

1. R

You need R version 4.3 or higher.

Download from CRAN
Verify your installation by running in a terminal:

R --version

2. Quarto

Quarto is used to render the .qmd notebooks into HTML.

Download from quarto.org
Verify your installation:

quarto --version

3. IDE (recommended)

Any of the following will work well:

IDE	Notes
RStudio	Quarto support built-in
VS Code / Cursor	Install the Quarto extension

Required R Packages

The use cases in this section rely on a set of common R packages. Install them all at once by running the following in your R console:

required_packages <- c(
  "httr2",      # HTTP requests to the GJD API
  "jsonlite",   # JSON parsing
  "dplyr",      # Data manipulation
  "tidyr",      # Data tidying
  "ggplot2",    # Data visualization
  "DT",         # Interactive tables
  "readr"       # Reading CSV / tabular data
)

install.packages(required_packages)

You can verify that all packages load correctly:

lapply(required_packages, library, character.only = TRUE)

Clone and Render

Once everything is installed, clone the repository and render the R section:

git clone <repo-url>
cd usecasegjd/R
quarto render

This will generate all HTML files from the .qmd notebooks. Open index.html in your browser to explore the results.

Render a single use case

quarto render my-use-case.qmd

Live preview while editing

quarto preview

This starts a local server and automatically refreshes the page when you save changes to any .qmd file.

Next Steps

You’re all set! Head to the Use Cases section in the sidebar to start exploring examples.

---
title: "Get Started"
subtitle: "Set up your environment to run the GJD R use cases"
---

## Prerequisites

Before running any of the examples in this section, make sure you have the following software installed on your machine.

### 1. R

You need **R version 4.3 or higher**.

- Download from [CRAN](https://cran.r-project.org/)
- Verify your installation by running in a terminal:

```bash
R --version
```

### 2. Quarto

Quarto is used to render the `.qmd` notebooks into HTML.

- Download from [quarto.org](https://quarto.org/docs/get-started/)
- Verify your installation:

```bash
quarto --version
```

### 3. IDE (recommended)

Any of the following will work well:

| IDE | Notes |
|-----|-------|
| [RStudio](https://posit.co/download/rstudio-desktop/) | Quarto support built-in |
| [VS Code](https://code.visualstudio.com/) / [Cursor](https://cursor.sh/) | Install the [Quarto extension](https://marketplace.visualstudio.com/items?itemName=quarto.quarto) |

## Required R Packages

The use cases in this section rely on a set of common R packages. Install them all at once by running the following in your R console:

```{r}
#| eval: false
required_packages <- c(
  "httr2",      # HTTP requests to the GJD API
  "jsonlite",   # JSON parsing
  "dplyr",      # Data manipulation
  "tidyr",      # Data tidying
  "ggplot2",    # Data visualization
  "DT",         # Interactive tables
  "readr"       # Reading CSV / tabular data
)

install.packages(required_packages)
```

You can verify that all packages load correctly:

```{r}
#| eval: false
lapply(required_packages, library, character.only = TRUE)
```

## Clone and Render

Once everything is installed, clone the repository and render the R section:

```bash
git clone <repo-url>
cd usecasegjd/R
quarto render
```

This will generate all HTML files from the `.qmd` notebooks. Open `index.html` in your browser to explore the results.

### Render a single use case

```bash
quarto render my-use-case.qmd
```

### Live preview while editing

```bash
quarto preview
```

This starts a local server and automatically refreshes the page when you save changes to any `.qmd` file.

## Next Steps

You're all set! Head to the **Use Cases** section in the sidebar to start exploring examples.