add_dataset: Ajoute un dataset
In nbc/didoscalim: Charger des données dans DiDo

add_dataset

R Documentation

Ajoute un dataset

Description

Ajoute un dataset

Usage

add_dataset(
  title,
  description,
  topic,
  frequency,
  tags = NULL,
  frequency_date = NULL,
  granularity = NULL,
  zones = NULL,
  organization = my_organization(),
  license = "fr-lo",
  temporal_coverage_start = NULL,
  temporal_coverage_end = NULL,
  caution = NULL,
  quiet = NULL
)

Arguments

`title`	le titre du dataset
`description`	la description du dataset
`topic`	le thème du dataset. Doit être dans "Environnement", "Énergie", "Transports", "Logement", "Changement climatique"
`frequency`	la fréquence de publication des données. Les fréquences les plus utilisées sont `annual`, `monthly`, `ponctual`. la liste complète des fréquences
`tags`	la liste des mots clefs. Si le fichier est déjà publié sur le site SDES, on reprend les mêmes. La liste des mots clefs recensés.
`frequency_date`	la date de prochaine publication.
`granularity`	la granularité du jeu de données. Les plus utilisés sont "fr:region", "fr:departement", "fr:epci", "fr:commune", "fr:iris" et pour les données à l'adresse "poi". La liste complète des granularités
`zones`	la zone couverte par le jeu de données. country:fr pour France entière, country-subset:fr:metro pour la métropole et country-subset:fr:drom pour les DROM
`organization`	l'id de l'organisation sous laquelle vous souhaitez publier le dataset, si vous n'appartenez qu'à une seule organisation, vous n'avez pas à remplir ce champ, didoscalim la prendra par défaut.
`license`	la licence des données. "fr-lo" par défaut
`temporal_coverage_start`	optionnel, la date de début de couverture du jeux de données au format AAAA-MM-JJ
`temporal_coverage_end`	optionnel, la date de fin de couverture du jeux de données au format AAAA-MM-JJ
`caution`	Les précautions à prendre avec ce jeu de données. Par exemple : "certaines données peuvent être secrétisées"
`quiet`	quand TRUE ou que l'option dido_quiet est à TRUE supprime les messages d'information, `NULL` par défaut

Value

un objet dido_dataset(). Ce dernier sert pour créer par la suite les datafiles et les millésimes.

Examples

dataset <- add_dataset(
  title = "le titre du dataset",
  description = "la description du dataset",
  topic = "Transports",
  frequency = "unknown"
)

nbc/didoscalim documentation built on Sept. 12, 2022, 10:17 a.m.