Ajoute ou met à jour un dataset

Cette fonction permet, par exemple, de modifier la période de couverture du dataset ainsi que la date de prochaine mise à jour.

Si plusieurs datasets ont le même titre, cette méthode retourne une erreur.

Si vous devez mettre à jour des datasets, il est conseillé d'utiliser la fonction didoscalim_update_only(), cf vignette("complements-sur-les-mises-a-jour")

Utilisation

add_or_update_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
)

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, unknown. 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. optionnel seulement la frequency est unknown.

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.

Si ça n'est pas le cas, vous devez préciser la fonction my_organization()

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"

Valeur de retour

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

Voir également

La liste des tags/mots clefs recensés

Other dataset: add_dataset(), dido_dataset(), get_dataset(), update_dataset()

Exemples

dataset <- add_or_update_dataset(
  title = "Des données statistiques",
  description = "Description des données statistiques",
  topic = "Transports",
  frequency = "annual",
  frequency_date = "2021-01-10",
  temporal_coverage_start = "2020-01-01",
  temporal_coverage_end = "2020-12-31"
)
#> dataset "Des données statistiques" modifié

dataset <- add_or_update_dataset(
  title = "Des données statistiques",
  description = "Description des données statistiques",
  topic = "Transports",
  frequency = "annual",
  frequency_date = "2022-01-10",
  temporal_coverage_start = "2021-01-01",
  temporal_coverage_end = "2021-12-31"
)
#> dataset "Des données statistiques" modifié