-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
232 lines (201 loc) · 14.8 KB
/
index.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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<!DOCTYPE html>
<html class="writer-html5" lang="ja" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Open Data Linter ドキュメント</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/translations.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="索引" href="genindex.html" />
<link rel="search" title="検索" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> Open Data Linter
</a>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html#document-csvlinter">CSV Linter</a></li>
<li class="toctree-l1"><a class="reference internal" href="index.html#document-excellinter">Excel Linter</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Open Data Linter</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> »</li>
<li>Open Data Linter ドキュメント</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-open-data-linter-s-documentation">
<h1>Welcome to Open Data Linter's documentation!<a class="headerlink" href="#welcome-to-open-data-linter-s-documentation" title="このヘッドラインへのパーマリンク"></a></h1>
<div class="toctree-wrapper compound">
<span id="document-csvlinter"></span><section id="csv-linter">
<h2>CSV Linter<a class="headerlink" href="#csv-linter" title="このヘッドラインへのパーマリンク"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">opendatalinter.</span></span><span class="sig-name descname"><span class="pre">CSVLinter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title_line_num</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_line_num</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter" title="この定義へのパーマリンク"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_1">
<span class="sig-name descname"><span class="pre">check_1_1</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_1" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-1に沿って、ファイル形式が Excel か CSV となっているか確認する。</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_10">
<span class="sig-name descname"><span class="pre">check_1_10</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_10" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-10に沿って，機種依存⽂字を使⽤していないか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>入力ファイルのエンコードが CP932 かつ shift_jis にデコードできない要素を invalid とみなす。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_11">
<span class="sig-name descname"><span class="pre">check_1_11</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_11" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-11に沿って、e-Stat の時間軸コードの表記、⻄暦表記⼜は和暦に⻄暦の併記がされているか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>時刻コードもしくは西暦が隣接する列に併記されていない和暦の列を invalid とみなす。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_12">
<span class="sig-name descname"><span class="pre">check_1_12</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_12" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック1-12に沿って、地域コードまたは地域名称が表記されているか確認する</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>都道府県のみチェックしている。表記揺れしている都道府県名もしくは，
都道府県コードが隣接する列に併記されていない，都道府県名が省略された列を invalid とみなす</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_13">
<span class="sig-name descname"><span class="pre">check_1_13</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_13" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-13に沿って、数値データの同一列内に特殊記号（秘匿等）が含まれるか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>数値データの同⼀列内に'0'、'X'、'<a href="#id1"><span class="problematic" id="id2">**</span></a><a href="#id3"><span class="problematic" id="id4">*</span></a>'以外の文字列が含まれる要素を invalid とみなす。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_2">
<span class="sig-name descname"><span class="pre">check_1_2</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_2" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目2-2に沿って、1セル1データとなっているか確認する。</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_3">
<span class="sig-name descname"><span class="pre">check_1_3</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_3" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-3に沿って、数値データは数値属性とし、⽂字列を含まないことを確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>単位が列全てに含まれている場合、列ごとに警告する。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_4">
<span class="sig-name descname"><span class="pre">check_1_4</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_4" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-4に沿って、セルの結合をしていないか確認する。（Excelのみ適用する）</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_5">
<span class="sig-name descname"><span class="pre">check_1_5</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_5" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-5に沿って、スペースや改⾏等で体裁を整えていないか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>スペースと改行を1つ以上含む要素を invalid とみなす。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_6">
<span class="sig-name descname"><span class="pre">check_1_6</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_6" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-6に沿って、項⽬名等を省略していないか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>ヘッダの欠損データを invalid とみなす。</p>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_1_7">
<span class="sig-name descname"><span class="pre">check_1_7</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_1_7" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-7に沿って、数式が使用されていないかを確認する。（Excelのみ適用する）</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.CSVLinter.check_2_x">
<span class="sig-name descname"><span class="pre">check_2_x</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.CSVLinter.check_2_x" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目2-1，2-2に沿って，データが分断されていないか，1シートに複数の表が掲載されていないか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>データのない行または列がある場合 invalid とみなす。</p>
</div>
</dd></dl>
</dd></dl>
</section>
<span id="document-excellinter"></span><section id="excel-linter">
<h2>Excel Linter<a class="headerlink" href="#excel-linter" title="このヘッドラインへのパーマリンク"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="opendatalinter.ExcelLinter">
<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">opendatalinter.</span></span><span class="sig-name descname"><span class="pre">ExcelLinter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">bytes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">filename</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">title_line_num</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">header_line_num</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.ExcelLinter" title="この定義へのパーマリンク"></a></dt>
<dd><dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.ExcelLinter.check_1_4">
<span class="sig-name descname"><span class="pre">check_1_4</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.ExcelLinter.check_1_4" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-4に沿って、セルの結合をしていないか確認する。</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="opendatalinter.ExcelLinter.check_1_7">
<span class="sig-name descname"><span class="pre">check_1_7</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#opendatalinter.ExcelLinter.check_1_7" title="この定義へのパーマリンク"></a></dt>
<dd><p>チェック項目1-7に沿って、数式を使⽤している場合は数値データに修正しているか確認する。</p>
<div class="admonition note">
<p class="admonition-title">注釈</p>
<p>'='から始まるセルを invalid とみなす。</p>
</div>
</dd></dl>
</dd></dl>
</section>
</div>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, Volare Tokyo.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>