Commit 9e746a91 authored by pitkant's avatar pitkant
Browse files

Built site for hetu: 1.0.7@9d3c9b5

parent aee40a2c
......@@ -93,7 +93,7 @@ Content not found. Please use links in the navbar.
<div class="pkgdown-footer-right">
<p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer>
......
......@@ -59,7 +59,7 @@ COPYRIGHT HOLDER: Pyry Kantanen, Måns Magnusson, Jussi Paananen, Leo Lahti
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
apple-touch-icon-120x120.png

7.83 KB | W: | H:

apple-touch-icon-120x120.png

7.83 KB | W: | H:

apple-touch-icon-120x120.png
apple-touch-icon-120x120.png
apple-touch-icon-120x120.png
apple-touch-icon-120x120.png
  • 2-up
  • Swipe
  • Onion skin
apple-touch-icon-152x152.png

10.2 KB | W: | H:

apple-touch-icon-152x152.png

10.2 KB | W: | H:

apple-touch-icon-152x152.png
apple-touch-icon-152x152.png
apple-touch-icon-152x152.png
apple-touch-icon-152x152.png
  • 2-up
  • Swipe
  • Onion skin
apple-touch-icon-180x180.png

12.3 KB | W: | H:

apple-touch-icon-180x180.png

12.3 KB | W: | H:

apple-touch-icon-180x180.png
apple-touch-icon-180x180.png
apple-touch-icon-180x180.png
apple-touch-icon-180x180.png
  • 2-up
  • Swipe
  • Onion skin
apple-touch-icon-60x60.png

3.81 KB | W: | H:

apple-touch-icon-60x60.png

3.81 KB | W: | H:

apple-touch-icon-60x60.png
apple-touch-icon-60x60.png
apple-touch-icon-60x60.png
apple-touch-icon-60x60.png
  • 2-up
  • Swipe
  • Onion skin
apple-touch-icon-76x76.png

4.69 KB | W: | H:

apple-touch-icon-76x76.png

4.69 KB | W: | H:

apple-touch-icon-76x76.png
apple-touch-icon-76x76.png
apple-touch-icon-76x76.png
apple-touch-icon-76x76.png
  • 2-up
  • Swipe
  • Onion skin
apple-touch-icon.png

12.3 KB | W: | H:

apple-touch-icon.png

12.3 KB | W: | H:

apple-touch-icon.png
apple-touch-icon.png
apple-touch-icon.png
apple-touch-icon.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -81,11 +81,11 @@
<div class="row">
<main id="main"><div class="page-header">
<main id="main" class="col-md-9"><div class="page-header">
<img src="../logo.png" class="logo" alt=""><h1>Finnish personal ID number data toolkit for R (hetu)</h1>
<h4 data-toc-skip class="author">Pyry Kantanen, Jussi Paananen, Mans Magnusson, Leo Lahti</h4>
<h4 data-toc-skip class="date">2022-06-01</h4>
<h4 data-toc-skip class="date">2022-06-22</h4>
<small class="dont-index">Source: <a href="https://github.com/rOpenGov/hetu/blob/HEAD/vignettes/hetu.Rmd" class="external-link"><code>vignettes/hetu.Rmd</code></a></small>
<div class="d-none name"><code>hetu.Rmd</code></div>
......@@ -226,14 +226,14 @@
<p>Extracting age at current date and at a given date with hetu_age function:</p>
<div class="sourceCode" id="cb10"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="fu"><a href="../reference/pin_age.html">hetu_age</a></span><span class="op">(</span><span class="va">example_pins</span><span class="op">)</span>
<span class="co">#&gt; The age in years has been calculated at 2022-06-01.</span>
<span class="co">#&gt; The age in years has been calculated at 2022-06-22.</span>
<span class="co">#&gt; [1] 121 110</span>
<span class="fu"><a href="../reference/pin_age.html">hetu_age</a></span><span class="op">(</span><span class="va">example_pins</span>, date <span class="op">=</span> <span class="st">"2012-01-01"</span><span class="op">)</span>
<span class="co">#&gt; The age in years has been calculated at 2012-01-01.</span>
<span class="co">#&gt; [1] 111 100</span>
<span class="fu"><a href="../reference/pin_age.html">hetu_age</a></span><span class="op">(</span><span class="va">example_pins</span>, timespan <span class="op">=</span> <span class="st">"months"</span><span class="op">)</span>
<span class="co">#&gt; The age in months has been calculated at 2022-06-01.</span>
<span class="co">#&gt; [1] 1457 1326</span></code></pre></div>
<span class="co">#&gt; The age in months has been calculated at 2022-06-22.</span>
<span class="co">#&gt; [1] 1457 1327</span></code></pre></div>
<p>Dates (birth dates) also have their own function, hetu_date.</p>
<div class="sourceCode" id="cb11"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="fu"><a href="../reference/pin_date.html">hetu_date</a></span><span class="op">(</span><span class="va">example_pins</span><span class="op">)</span>
......@@ -452,15 +452,15 @@
<p>Random PINs can be generated by using the rpin function.</p>
<div class="sourceCode" id="cb19"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="fu"><a href="../reference/rpin.html">rhetu</a></span><span class="op">(</span>n <span class="op">=</span> <span class="fl">4</span><span class="op">)</span>
<span class="co">#&gt; [1] "131150-8707" "300576-042B" "180876-462K" "250599-3223"</span>
<span class="co">#&gt; [1] "220725-668U" "250183-442L" "270295-740D" "110898-250W"</span>
<span class="fu"><a href="../reference/rpin.html">rhetu</a></span><span class="op">(</span>n <span class="op">=</span> <span class="fl">4</span>, start.date <span class="op">=</span> <span class="st">"1990-01-01"</span>, end.date <span class="op">=</span> <span class="st">"2005-01-01"</span><span class="op">)</span>
<span class="co">#&gt; [1] "240991-1203" "130197-333Y" "021299-137X" "250700A364H"</span></code></pre></div>
<span class="co">#&gt; [1] "220401A434N" "200901A3003" "190602A218M" "180304A8759"</span></code></pre></div>
<p>The number of males in the generated sample can be changed with parameter p.male. Default is 0.4.</p>
<div class="sourceCode" id="cb20"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="va">random_sample</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/rpin.html">rhetu</a></span><span class="op">(</span>n <span class="op">=</span> <span class="fl">4</span>, p.male <span class="op">=</span> <span class="fl">0.8</span><span class="op">)</span>
<span class="fu"><a href="https://rdrr.io/r/base/table.html" class="external-link">table</a></span><span class="op">(</span><span class="va">random_sample</span><span class="op">)</span>
<span class="co">#&gt; random_sample</span>
<span class="co">#&gt; 090516-091W 120705-721X 121274-375L 220358-1713 </span>
<span class="co">#&gt; 011264-326B 180812A5220 201177-125N 301206-7636 </span>
<span class="co">#&gt; 1 1 1 1</span></code></pre></div>
<p>The default proportion of artificial / temporary PINs is 0.0, meaning that no artificial / temporary PINs are generated by default.</p>
<div class="sourceCode" id="cb21"><pre class="downlit sourceCode r">
......@@ -523,7 +523,7 @@
<div class="sourceCode" id="cb26"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span class="va">bid_sample</span> <span class="op">&lt;-</span> <span class="fu"><a href="../reference/rbid.html">rbid</a></span><span class="op">(</span><span class="fl">3</span><span class="op">)</span>
<span class="va">bid_sample</span>
<span class="co">#&gt; [1] "1473807-3" "7148849-6" "6406344-9"</span></code></pre></div>
<span class="co">#&gt; [1] "6779765-9" "9754400-3" "9339607-4"</span></code></pre></div>
</div>
<div class="section level3">
<h3 id="bid-validity-checking">BID validity checking<a class="anchor" aria-label="anchor" href="#bid-validity-checking"></a>
......@@ -624,7 +624,7 @@
<span class="co">#&gt; [5] rlang_1.0.2 fastmap_1.1.0 highr_0.9 stringr_1.4.0 </span>
<span class="co">#&gt; [9] tools_4.2.0 parallel_4.2.0 checkmate_2.1.0 xfun_0.31 </span>
<span class="co">#&gt; [13] cli_3.3.0 jquerylib_0.1.4 htmltools_0.5.2 systemfonts_1.0.4</span>
<span class="co">#&gt; [17] yaml_2.3.5 digest_0.6.29 rprojroot_2.0.3 pkgdown_2.0.3 </span>
<span class="co">#&gt; [17] yaml_2.3.5 digest_0.6.29 rprojroot_2.0.3 pkgdown_2.0.4 </span>
<span class="co">#&gt; [21] textshaping_0.3.6 purrr_0.3.4 sass_0.4.1 fs_1.5.2 </span>
<span class="co">#&gt; [25] memoise_2.0.1 cachem_1.0.6 evaluate_0.15 rmarkdown_2.14 </span>
<span class="co">#&gt; [29] stringi_1.7.6 compiler_4.2.0 bslib_0.3.1 generics_0.1.2 </span>
......@@ -643,7 +643,7 @@
<div class="pkgdown-footer-right">
<p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer>
......
......@@ -61,7 +61,7 @@
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
......@@ -101,7 +101,7 @@
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
This source diff could not be displayed because it is too large. You can view the blob instead.
favicon-16x16.png

1.25 KB | W: | H:

favicon-16x16.png

1.25 KB | W: | H:

favicon-16x16.png
favicon-16x16.png
favicon-16x16.png
favicon-16x16.png
  • 2-up
  • Swipe
  • Onion skin
favicon-32x32.png

2.15 KB | W: | H:

favicon-32x32.png

2.15 KB | W: | H:

favicon-32x32.png
favicon-32x32.png
favicon-32x32.png
favicon-32x32.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -220,7 +220,7 @@
<div class="pkgdown-footer-right">
<p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer>
......
......@@ -129,7 +129,7 @@
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
pandoc: 2.14.2
pkgdown: 2.0.3
pkgdown: 2.0.4
pkgdown_sha: ~
articles:
hetu: hetu.html
last_built: 2022-06-01T09:04Z
last_built: 2022-06-22T11:05Z
urls:
reference: https://ropengov.github.io/hetu/reference
article: https://ropengov.github.io/hetu/articles
......
......@@ -64,6 +64,7 @@ Returns <code>TRUE</code> or <code>FALSE</code>.</p>
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt>bid</dt>
<dd><p>a vector of 1 or more business identity numbers</p></dd>
</dl></div>
<div class="section level2">
......@@ -83,7 +84,7 @@ Returns <code>TRUE</code> or <code>FALSE</code>.</p>
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
......@@ -82,7 +82,7 @@
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
......@@ -64,26 +64,35 @@
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt>pin</dt>
<dd><p>Finnish personal identity code(s) as a character vector</p></dd>
<dt>extract</dt>
<dd><p>Extract only selected part of the information.
Valid values are "<code>hetu</code>", "<code>sex</code>", "<code>p.num</code>",
"<code>ctrl.char</code>", "<code>date</code>", "<code>day</code>", "<code>month</code>",
"<code>year</code>", "<code>century</code>", "<code>is.temp</code>".
If <code>NULL</code> (default), returns all information.</p></dd>
<dt>allow.temp</dt>
<dd><p>Allow artificial or temporary PINs (personal numbers
900-999). If <code>FALSE</code> (default), only PINs intended for official
use (personal numbers 002-899) are allowed.</p></dd>
<dt>diagnostic</dt>
<dd><p>Print additional information about possible problems in
PINs. The checks are "<code>valid.p.num</code>", "<code>valid.ctrl.char</code>",
"<code>correct.ctrl.char</code>", "<code>valid.date</code>", "<code>valid.day</code>",
"<code>valid.month</code>", "<code>valid.length</code>", "<code>valid.century</code>".
Default is <code>FALSE</code> which returns no diagnostic information.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>Finnish personal identity code data.frame,
<p>Finnish personal identity code data.frame,
or if extract parameter is set, the requested part of the
information as a vector. Returns an error or <code>NA</code> if the given
character vector is not a valid Finnish personal identity code.</p>
......@@ -92,26 +101,36 @@ Default is <code>FALSE</code> which returns no diagnostic information.</p></dd>
A correct pin should be in the form DDMMYYCZZZQ, where DDMMYY stands for
date, C for century sign, ZZZ for personal number and Q for control
character.</p></dd>
<dt>sex</dt>
<dd><p>sex of the person as a character vector ("Male" or "Female").</p></dd>
<dt>p.num</dt>
<dd><p>Personal number part of the identity code.</p></dd>
<dt>ctrl.char</dt>
<dd><p>Control character for the personal identity code.</p></dd>
<dt>date</dt>
<dd><p>Birthdate.</p></dd>
<dt>day</dt>
<dd><p>Day of the birthdate.</p></dd>
<dt>month</dt>
<dd><p>Month of the birthdate.</p></dd>
<dt>year</dt>
<dd><p>Year of the birthdate.</p></dd>
<dt>century</dt>
<dd><p>Century character of the birthdate: + (1800), - (1900) or
A (2000).</p></dd>
<dt>valid.pin</dt>
<dd><p>Does the personal identity code pass all validity
checks: (<code>TRUE</code> or <code>FALSE</code>)</p></dd>
</dl></div>
<div class="section level2">
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
......@@ -158,7 +177,7 @@ Default is <code>FALSE</code> which returns no diagnostic information.</p></dd>
</div>
<div class="pkgdown-footer-right">
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
</div>
</footer></div>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment