load_hist_data: Chargement de données historiques

Description Usage Arguments Value Methods (by class)

View source: R/interface_generics.R

Description

Charge les données historiques de signaux faibles et les stocke dans un champ "hist_data" de l'objet task

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## S3 method for class 'sf_task'
load_hist_data(
  task,
  batch = "latest",
  database = task[["database"]],
  collection = task[["collection"]],
  mongodb_uri = task[["mongodb_uri"]],
  subsample = NULL,
  fields = get_fields(training = FALSE),
  date_inf = as.Date("2015-01-01"),
  date_sup = as.Date("2017-01-01"),
  min_effectif = 10L,
  sirets = NULL,
  code_ape = NULL,
  database_query_fun = query_mongodb,
  ...
)

load_hist_data(task, ...)

Arguments

task

[sf_task]
Objet s3 de type sf_task

batch

character(1)
Batch auquel doit être importées les données. Les modifications opérées par les batchs ultérieurs sont ignorées. Par défaut, le dernier présent dans la collection Admin de MongoDB.

database

character(1)
Nom de la base de données vers laquelle param exporter. Par défaut, celle stockée dans task.

collection

character(1)
Nom de la collection vers laquelle exporter. Par défaut, celle stockée dans task.

mongodb_uri

character(1)
url to the database in mongodb uri format.

subsample

integer(1)
Nombre d'objets (c'est-à-dire de couples siret x periode) à échantillonner.

fields

character()
Noms des champs à requêter dans la base de données. Doit contenir "siret" et "periode". Si égal à NULL, alors charge tous les champs disponibles.

date_inf

Date
Date inférieure du chargement des données.

date_sup

Date
Date supérieure (exclue) du chargement des données.

min_effectif

integer(1)
Limite basse du filtrage de l'effectif (la limite est incluse)

sirets

character()
Liste de sirets à exporter. Si égale à NULL, charge tous les sirens disponibles.

code_ape

character()
Liste de codes APE à exporter. Si égale à NULL, charge tous les codes disponibles.

database_query_fun

function
Fonction qui permet de requêter la base de données.

...

Additional parameters depending on class of task

Value

[sf_task]
L'objet task donné en entrée auquel le champs "hist_data" a été ajouté (ou écrasé), contenant un data.frame() avec les colonnes incluses dans le paramètre d'entrée fields, et pour chaque ligne un couple unique siret x periode.

Methods (by class)


signaux-faibles/rsignauxfaibles documentation built on Dec. 2, 2020, 3:24 a.m.