Passer au contenu

Ajoute un datafile à un dataset

Utilisation

add_datafile(
  dataset,
  title,
  description,
  file_name,
  millesime = format(Sys.time(), "%Y-%m"),
  published = format(Sys.time(), "%Y-%m-%d %H:%M:%S"),
  temporal_coverage_start = NULL,
  temporal_coverage_end = NULL,
  legal_notice = "SDES",
  date_diffusion = format(Sys.time(), "%Y-%m-%d %H:%M:%S")
)

Arguments

dataset

l'id d'un dataset, un objet dido_dataset(), dido_datafile() ou dido_job()

title

le titre du datafile

description

la description du datafile

file_name

le nom du fichier à charger

millesime

le millesime (AAAA-MM). Par défaut AAAA-MM avec l'année courante et le mois courant

published

la date/heure de publication du fichier, si non précisée, prend la date/heure du moment.

Ce paramètre est au format "AAAA-MM-JJ HH:MM:SS" (ou ISO8601 si vous préférez). Si la timezone n'est pas précisée, la timezone de l'ordinateur local est utilisée.

temporal_coverage_start

optionnel, la date de début de couverture du fichier de données au format AAAA-MM-JJ

temporal_coverage_end

optionnel, la date de fin de couverture du fichier de données au format AAAA-MM-JJ

legal_notice

les mentions légales, par défaut "SDES"

date_diffusion

(optionnel) les date et heure auxquelles le fichier devra être rendu accessible à la diffusion.

Ce paramètre est au format "AAAA-MM-JJ HH:MM:SS" (ou ISO8601 si vous préférez). Si la timezone n'est pas précisée, la timezone de l'ordinateur local est utilisée.

Si cette date/heure est dans le passé, les données sont immédiatement accessibles, si elle est dans le futur, les données ne seront accessibles qu'à cette date/heure.

Si ce paramètre est non précisé prend la date/heure courante, les données sont donc immédiatement accessibles.

Valeur de retour

un objet dido_job()

Exemples

library(dplyr, warn.conflicts = FALSE)

dataset <- add_or_update_dataset(
  title = "Un dataset pour les datafiles",
  description = "Description des données statistiques",
  topic = "Transports",
  frequency = "unknown",
)
#> dataset `Un dataset pour les datafiles` créé

add_datafile(
  dataset = dataset,
  title = "titre",
  description = "description",
  file_name = dido_example("augmente.csv")
)
#>     intégration du fichier `/home/nc/travail/R/didoscalim/inst/extdata/augmente.csv`
#> 	* fichier versé
#> 	* fichier validé
#> 	* fichier intégré: 	 rid: d5590649-0138-4b65-8704-8b7df8cbeb03	 millesime: 2023-10	 lignes: 5

# publier un fichier de données avec toutes les métadonnées et un embargo
add_datafile(
  dataset = dataset,
  title = "titre 2",
  description = "description 2",
  file_name = dido_example("augmente.csv"),
  temporal_coverage_start = "2021-01-01",
  temporal_coverage_end = "2021-12-31",
  legal_notice = "something",
  millesime = "2020-10",
  date_diffusion = "2020-11-01 07:45:00"
)
#>     intégration du fichier `/home/nc/travail/R/didoscalim/inst/extdata/augmente.csv`
#> 	* fichier versé
#> 	* fichier validé
#> 	* fichier intégré: 	 rid: 24d51d88-a5f5-4c4d-b5b1-a2ee79bb8fd8	 millesime: 2020-10	 lignes: 5