-
Notifications
You must be signed in to change notification settings - Fork 11
/
CONTRIBUTING.html
136 lines (111 loc) · 8.77 KB
/
CONTRIBUTING.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Guide du contributeur • doremifasol</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="bootstrap-toc.css"><script src="bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet"><script src="pkgdown.js"></script><meta property="og:title" content="Guide du contributeur"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]--></head><body data-spy="scroll" data-target="#toc">
<div class="container template-title-body">
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<span class="navbar-brand">
<a class="navbar-link" href="index.html">doremifasol</a>
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">0.5.6.0001</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav"><li>
<a href="index.html">
<span class="fas fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="articles/donnees_dispo.html">Données disponibles</a>
</li>
<li>
<a href="reference/index.html">Fonctions</a>
</li>
</ul><ul class="nav navbar-nav navbar-right"><li>
<a href="https://github.com/InseeFrLab/DoReMIFaSol/" class="external-link">
<span class="fab fa-github fa-lg"></span>
Contribuer
</a>
</li>
</ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
</header><div class="row">
<div class="contents col-md-9">
<div class="page-header">
<h1>Guide du contributeur</h1>
</div>
<div id="guide-du-contributeur" class="section level1">
<div class="section level2">
<h2 id="ajout-dune-source-de-données">Ajout d’une source de données<a class="anchor" aria-label="anchor" href="#ajout-dune-source-de-donn%C3%A9es"></a></h2>
<p>Le référentiel des sources disponibles ne se met pas à jour automatiquement.</p>
<p><strong>Pour qu’un administrateur du package intègre lui-même la source ou en cas de doute sur la pertinence de l’ajout, il est possible de la proposer via l’ouverture d’une <a href="https://github.com/InseeFrLab/DoReMIFaSol/issues/new/choose" class="external-link"><em>issue</em></a>.</strong></p>
<p>On peut aussi <strong>ajouter soi-même une nouvelle source</strong>, il faut pour cela :</p>
<ol style="list-style-type: decimal"><li>
<p>modifier le fichier <code>data-raw/liste_donnees.json</code>. Une source doit comporter les champs suivants :</p>
<table class="table"><colgroup><col width="30%"><col width="69%"></colgroup><thead><tr class="header"><th align="left">Champ</th>
<th align="left">Description</th>
</tr></thead><tbody><tr class="odd"><td align="left"><code>nom</code></td>
<td align="left">identifiant des données</td>
</tr><tr class="even"><td align="left"><code>libelle</code></td>
<td align="left">descriptif des données</td>
</tr><tr class="odd"><td align="left"><code>date_ref</code></td>
<td align="left">éventuellement, date de référence des données</td>
</tr><tr class="even"><td align="left"><code>collection</code></td>
<td align="left">thématique ou la source</td>
</tr><tr class="odd"><td align="left"><code>lien</code></td>
<td align="left">URL pour le téléchargement des données</td>
</tr><tr class="even"><td align="left"><code>type</code></td>
<td align="left">format des données</td>
</tr><tr class="odd"><td align="left"><code>zip</code></td>
<td align="left">les données sont-elles zippées ou non ? (booléen)</td>
</tr><tr class="even"><td align="left"><code>big_zip</code></td>
<td align="left">pour repérer les fichiers zippés dont la taille dépasse 4 Go et qui doivent alors faire l’objet d’une procédure particulière au moment de la décompression (booléen)</td>
</tr><tr class="odd"><td align="left"><code>fichier_donnees</code></td>
<td align="left">nom du fichier de données, dans le zip éventuel</td>
</tr><tr class="even"><td align="left"><code>fichier_meta</code></td>
<td align="left">nom du fichier descriptif des données, dans le zip éventuel</td>
</tr><tr class="odd"><td align="left"><code>onglet</code></td>
<td align="left">nom de l’onglet, si fichier tableur</td>
</tr><tr class="even"><td align="left"><code>premiere_ligne</code></td>
<td align="left">première ligne à lire pour charger dans R, si fichier tableur</td>
</tr><tr class="odd"><td align="left"><code>derniere_ligne</code></td>
<td align="left">dernière ligne à lire pour charger dans R, si fichier tableur</td>
</tr><tr class="even"><td align="left"><code>separateur</code></td>
<td align="left">séparateur de colonnes, si fichier texte</td>
</tr><tr class="odd"><td align="left"><code>encoding</code></td>
<td align="left">encodage du fichier</td>
</tr><tr class="even"><td align="left"><code>valeurs_manquantes</code></td>
<td align="left">valeurs à remplacer par <code>NA</code> lors de l’import dans R</td>
</tr><tr class="odd"><td align="left"><code>api_rest</code></td>
<td align="left">nécessité de passer par une API REST (booléen)</td>
</tr><tr class="even"><td align="left"><code>md5</code></td>
<td align="left">somme de contrôle du fichier à télécharger (32 caractères hexadécimaux). Sert à vérifier si un téléchargement doit être effectué dans le cas où un fichier au nom identique est présent dans le dossier.</td>
</tr><tr class="odd"><td align="left"><code>size</code></td>
<td align="left">taille du fichier à télécharger (en octets)</td>
</tr></tbody></table></li>
<li><p>exécuter le programme <code>data-raw/liste_donnees.R</code> pour générer les objets R associés.</p></li>
</ol></div>
</div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
</nav></div>
</div>
<footer><div class="copyright">
<p></p><p>Developed by Pierre Lamarche, Pierre-Yves Berrard.</p>
</div>
<div class="pkgdown">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>
</footer></div>
</body></html>