---
title: "Prise en main"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{Prise en main}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

```{r setup, echo = FALSE}
library(melodi)
```

# Parcourir les jeux de données disponibles

La fonction `get_catalog()` permet de lister l'ensemble des jeux de données disponibles [sur le catalogue de données de l'Insee](https://catalogue-donnees.insee.fr).

Chaque jeux de données (dataset, `DS`) dispose d'un identifiant unique (`identifier`) qui sera utile au requêtage.

Une séléction de métadonnées est également proposé : description du jeu de données, date de dernière mise à jour, nombre de lignes...

```{r get_catalog, eval = FALSE}
get_catalog()
```

# Obtenir des informations sur un jeu de données

Intéressons nous aux données de populations de référence issues du recensement de la population. L'identifiant du jeu de données est `DS_POPULATIONS_REFERENCE`.

A l'aide de cet identifiant, `get_metadata()` permet d'obtenir les métadonnées associées à ce jeu de données

```{r get_metadata, eval = FALSE}
ds_metadata <- get_metadata(ds_name = "DS_POPULATIONS_REFERENCE")
```

# Charger entièrement les données d'un jeu de données

A l'aide de l'identifiant du jeu de données, `get_all_data()` permet d'obtenir sous forme de data.frame le jeu de données dans son intégralité, non filtré.

```{r get_all_data, eval = FALSE}
data <- get_all_data(ds_name = "DS_POPULATIONS_REFERENCE")
```

# Aller plus loin

Se référerer aux autres articles pour d'autres cas d'usage : 
filtrer à l'aide de l'explorateur, filtrer par critère géographique, etc.

