summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/authors.html20
-rw-r--r--docs/index.html24
-rw-r--r--docs/pkgdown.css129
-rw-r--r--docs/pkgdown.js88
-rw-r--r--docs/reference/index.html56
-rw-r--r--docs/reference/install_PELMO.html38
6 files changed, 296 insertions, 59 deletions
diff --git a/docs/authors.html b/docs/authors.html
index e8abd36..46a2aa2 100644
--- a/docs/authors.html
+++ b/docs/authors.html
@@ -18,19 +18,25 @@
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+<!-- clipboard.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="pkgdown.css" rel="stylesheet">
<script src="jquery.sticky-kit.min.js"></script>
<script src="pkgdown.js"></script>
-
+
+
+<meta property="og:title" content="Authors" />
<!-- mathjax -->
-<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
@@ -49,6 +55,12 @@
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
+ <a href="index.html">
+ <span class="fa fa-home fa-lg"></span>
+
+ </a>
+</li>
+<li>
<a href="reference/index.html">Reference</a>
</li>
</ul>
@@ -71,7 +83,7 @@
<ul class="list-unstyled">
<li>
- <p><strong>Johannes Ranke</strong>. Author, maintainer, copyright&nbsp;holder.
+ <p><strong>Johannes Ranke</strong>. Author, maintainer, copyright holder.
</p>
</li>
</ul>
@@ -87,7 +99,7 @@
</div>
<div class="pkgdown">
- <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+ <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
diff --git a/docs/index.html b/docs/index.html
index 878949a..9d7b5cd 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -8,8 +8,12 @@
<title>Install FOCUS PELMO into an R library location • PELMO.installeR</title>
<!-- jquery --><script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script><!-- Bootstrap --><link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script><!-- Font Awesome icons --><link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
-<!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
-<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><!-- mathjax --><script src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script><!--[if lt IE 9]>
+<!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script><!-- pkgdown --><link href="pkgdown.css" rel="stylesheet">
+<script src="jquery.sticky-kit.min.js"></script><script src="pkgdown.js"></script><meta property="og:title" content="Install FOCUS PELMO into an R library location">
+<meta property="og:description" content="The only function in this package downloads 'FOCUS PELMO' from the
+ official website and installs it into the installation directory of this package.">
+<meta name="twitter:card" content="summary">
+<!-- mathjax --><script src="https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></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]-->
@@ -29,6 +33,12 @@
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
+ <a href="index.html">
+ <span class="fa fa-home fa-lg"></span>
+
+ </a>
+</li>
+<li>
<a href="reference/index.html">Reference</a>
</li>
</ul>
@@ -45,16 +55,16 @@
<div class="contents col-md-9">
<div id="pelmo-installer" class="section level1">
<div class="page-header"><h1 class="hasAnchor">
-<a href="#pelmo-installer" class="anchor"> </a>PELMO.installeR</h1></div>
+<a href="#pelmo-installer" class="anchor"></a>PELMO.installeR</h1></div>
<p>The R package <strong>PELMO.installeR</strong> provides a way to install <a href="http://esdac.jrc.ec.europa.eu/projects/pelmo">FOCUS PELMO</a> in a standardised way on Linux/Unix systems for use with <a href="https://www.winehq.org">wine</a>.</p>
<div id="note" class="section level2">
<h2 class="hasAnchor">
-<a href="#note" class="anchor"> </a>Note</h2>
+<a href="#note" class="anchor"></a>Note</h2>
<p>If you (re)install this package, you will have to <a href="https://pkgdown.jrwb.de/PELMO.installeR/reference/install_PELMO.html">(re)install PELMO</a> afterwards.</p>
</div>
<div id="use" class="section level2">
<h2 class="hasAnchor">
-<a href="#use" class="anchor"> </a>Use</h2>
+<a href="#use" class="anchor"></a>Use</h2>
<p>Please refer to the <a href="https://pkgdown.jrwb.de/PELMO.installeR/reference/index.html">reference</a>.</p>
</div>
</div>
@@ -65,7 +75,7 @@
<p>GPL</p>
<h2>Developers</h2>
<ul class="list-unstyled">
-<li>Johannes Ranke <br><small class="roles"> Author, maintainer, copyright holder </small> </li>
+<li>Johannes Ranke <br><small class="roles"> Author, maintainer, copyright holder </small> </li>
</ul>
</div>
</div>
@@ -76,7 +86,7 @@
</div>
<div class="pkgdown">
- <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+ <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
diff --git a/docs/pkgdown.css b/docs/pkgdown.css
index fd7b0ba..181fe63 100644
--- a/docs/pkgdown.css
+++ b/docs/pkgdown.css
@@ -34,13 +34,14 @@ img.icon {
float: right;
}
-/* Section anchors ---------------------------------*/
-
-.hasAnchor {
- margin-left: -30px;
+img {
+ max-width: 100%;
}
+/* Section anchors ---------------------------------*/
+
a.anchor {
+ margin-left: -30px;
display:inline-block;
width: 30px;
height: 30px;
@@ -56,6 +57,13 @@ a.anchor {
visibility: visible;
}
+@media (max-width: 767px) {
+ .hasAnchor:hover a.anchor {
+ visibility: hidden;
+ }
+}
+
+
/* Fixes for fixed navbar --------------------------*/
.contents h1, .contents h2, .contents h3, .contents h4 {
@@ -63,6 +71,17 @@ a.anchor {
margin-top: -60px;
}
+/* Static header placement on mobile devices */
+@media (max-width: 767px) {
+ .navbar-fixed-top {
+ position: absolute;
+ }
+ .navbar {
+ padding: 0;
+ }
+}
+
+
/* Sidebar --------------------------*/
#sidebar {
@@ -81,33 +100,95 @@ a.anchor {
margin-bottom: 0.5em;
}
+.orcid {
+ height: 16px;
+ vertical-align: middle;
+}
+
+/* Reference index & topics ----------------------------------------------- */
+
+.ref-index th {font-weight: normal;}
+.ref-index h2 {font-size: 20px;}
+
+.ref-index td {vertical-align: top;}
+.ref-index .alias {width: 40%;}
+.ref-index .title {width: 60%;}
+
+.ref-index .alias {width: 40%;}
+.ref-index .title {width: 60%;}
+
+.ref-arguments th {text-align: right; padding-right: 10px;}
+.ref-arguments th, .ref-arguments td {vertical-align: top;}
+.ref-arguments .name {width: 20%;}
+.ref-arguments .desc {width: 80%;}
+
+/* Nice scrolling for wide elements --------------------------------------- */
+
+table {
+ display: block;
+ overflow: auto;
+}
+
/* Syntax highlighting ---------------------------------------------------- */
-code {
- background-color: #f7f7f7;
- color: #333;
+pre {
+ word-wrap: normal;
+ word-break: normal;
+ border: 1px solid #eee;
}
-code a {
- color: #375f84;
+
+pre, code {
+ background-color: #f8f8f8;
+ color: #333;
}
-.warning { color: red; }
-.message { font-weight: bolder; }
-.error { color: red; font-weight: bolder; }
+pre code {
+ overflow: auto;
+ word-wrap: normal;
+ white-space: pre;
+}
-.fl,.number {color:rgb(21,20,181);}
-.fu,.functioncall {color:#264D66 ;}
-.ch,.st,.string {color:#375D81 ;}
-.kw,.keyword {color:black;}
-.argument {color:#264D66 ;}
-.co,.comment {color: #777;}
-.formalargs {color: #264D66;}
-.eqformalargs {color:#264D66;}
-.slot {font-style:italic;}
-.symbol {color:black ;}
-.prompt {color:black ;}
+pre .img {
+ margin: 5px 0;
+}
-pre img {
+pre .img img {
background-color: #fff;
display: block;
+ height: auto;
+}
+
+code a, pre a {
+ color: #375f84;
+}
+
+a.sourceLine:hover {
+ text-decoration: none;
+}
+
+.fl {color: #1514b5;}
+.fu {color: #000000;} /* function */
+.ch,.st {color: #036a07;} /* string */
+.kw {color: #264D66;} /* keyword */
+.co {color: #888888;} /* comment */
+
+.message { color: black; font-weight: bolder;}
+.error { color: orange; font-weight: bolder;}
+.warning { color: #6A0366; font-weight: bolder;}
+
+/* Clipboard --------------------------*/
+
+.hasCopyButton {
+ position: relative;
+}
+
+.btn-copy-ex {
+ position: absolute;
+ right: 0;
+ top: 0;
+ visibility: hidden;
+}
+
+.hasCopyButton:hover button.btn-copy-ex {
+ visibility: visible;
}
diff --git a/docs/pkgdown.js b/docs/pkgdown.js
index c8b38c4..64b20df 100644
--- a/docs/pkgdown.js
+++ b/docs/pkgdown.js
@@ -1,8 +1,94 @@
$(function() {
- $("#sidebar").stick_in_parent({offset_top: 40});
+
+ $("#sidebar")
+ .stick_in_parent({offset_top: 40})
+ .on('sticky_kit:bottom', function(e) {
+ $(this).parent().css('position', 'static');
+ })
+ .on('sticky_kit:unbottom', function(e) {
+ $(this).parent().css('position', 'relative');
+ });
+
$('body').scrollspy({
target: '#sidebar',
offset: 60
});
+ var cur_path = paths(location.pathname);
+ $("#navbar ul li a").each(function(index, value) {
+ if (value.text == "Home")
+ return;
+ if (value.getAttribute("href") === "#")
+ return;
+
+ var path = paths(value.pathname);
+ if (is_prefix(cur_path, path)) {
+ // Add class to parent <li>, and enclosing <li> if in dropdown
+ var menu_anchor = $(value);
+ menu_anchor.parent().addClass("active");
+ menu_anchor.closest("li.dropdown").addClass("active");
+ }
+ });
});
+
+function paths(pathname) {
+ var pieces = pathname.split("/");
+ pieces.shift(); // always starts with /
+
+ var end = pieces[pieces.length - 1];
+ if (end === "index.html" || end === "")
+ pieces.pop();
+ return(pieces);
+}
+
+function is_prefix(needle, haystack) {
+ if (needle.length > haystack.lengh)
+ return(false);
+
+ for (var i = 0; i < haystack.length; i++) {
+ if (needle[i] != haystack[i])
+ return(false);
+ }
+
+ return(true);
+}
+
+/* Clipboard --------------------------*/
+
+function changeTooltipMessage(element, msg) {
+ var tooltipOriginalTitle=element.getAttribute('data-original-title');
+ element.setAttribute('data-original-title', msg);
+ $(element).tooltip('show');
+ element.setAttribute('data-original-title', tooltipOriginalTitle);
+}
+
+if(Clipboard.isSupported()) {
+ $(document).ready(function() {
+ var copyButton = "<button type='button' class='btn btn-primary btn-copy-ex' type = 'submit' title='Copy to clipboard' aria-hidden='true' data-toggle='tooltip' data-placement='left auto' data-trigger='hover' data-clipboard-copy><i class='fa fa-copy' aria-hidden='true'></i></button>";
+
+ $(".examples").addClass("hasCopyButton");
+
+ // Insert copy buttons:
+ $(copyButton).prependTo(".hasCopyButton");
+
+ // Initialize tooltips:
+ $('.btn-copy-ex').tooltip({container: 'body'});
+
+ // Initialize clipboard:
+ var clipboardBtnCopies = new Clipboard('[data-clipboard-copy]', {
+ text: function(trigger) {
+ return trigger.parentNode.textContent;
+ }
+ });
+
+ clipboardBtnCopies.on('success', function(e) {
+ changeTooltipMessage(e.trigger, 'Copied!');
+ e.clearSelection();
+ });
+
+ clipboardBtnCopies.on('error', function() {
+ changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy');
+ });
+ });
+}
+
diff --git a/docs/reference/index.html b/docs/reference/index.html
index 6410de9..98764f7 100644
--- a/docs/reference/index.html
+++ b/docs/reference/index.html
@@ -18,19 +18,25 @@
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+<!-- clipboard.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
-
+
+
+<meta property="og:title" content="Function reference" />
<!-- mathjax -->
-<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
@@ -49,6 +55,12 @@
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
+ <a href="../index.html">
+ <span class="fa fa-home fa-lg"></span>
+
+ </a>
+</li>
+<li>
<a href="../reference/index.html">Reference</a>
</li>
</ul>
@@ -66,20 +78,36 @@
<div class="row">
<div class="col-md-9">
<div class="page-header">
- <h1>Function reference</h1>
- <h4>version&nbsp;0.1-1</h4>
+ <h1>
+ Reference
+ <small>version&nbsp;0.1-1</small>
+ </h1>
</div>
<div class="contents">
- <h2 id="section-all-functions" class="hasAnchor"><a href="#section-all-functions" class="anchor"></a>All functions</h2>
- <p class="section-desc"></p>
-
-
- <p><a href="install_PELMO.html">Download FOCUS PELMO from the official site and unzip into the package installation directory</a></p>
- <ul>
- <li><code><a href="install_PELMO.html">install_PELMO</a></code></li>
- </ul>
-
+ <table class="ref-index">
+
+ <colgroup>
+ <col class="alias" />
+ <col class="title" />
+ </colgroup>
+
+ <tbody>
+ <tr>
+ <th colspan="2">
+ <h2 id="section-all-functions" class="hasAnchor"><a href="#section-all-functions" class="anchor"></a>All functions</h2>
+ <p class="section-desc"></p>
+ </th>
+ </tr>
+ <tr>
+ <!-- -->
+ <td>
+ <p><code><a href="install_PELMO.html">install_PELMO</a></code> </p>
+ </td>
+ <td><p>Download FOCUS PELMO from the official site and unzip into the package installation directory</p></td>
+ </tr>
+ </tbody>
+ </table>
</div>
</div>
@@ -97,7 +125,7 @@
</div>
<div class="pkgdown">
- <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+ <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
diff --git a/docs/reference/install_PELMO.html b/docs/reference/install_PELMO.html
index 1f83be8..c2a9feb 100644
--- a/docs/reference/install_PELMO.html
+++ b/docs/reference/install_PELMO.html
@@ -18,19 +18,28 @@
<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+<!-- clipboard.js -->
+<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
+
+
+<meta property="og:title" content="Download FOCUS PELMO from the official site and unzip into the package installation directory — install_PELMO" />
+<meta property="og:description" content="Download FOCUS PELMO from the official site and unzip into the package installation directory" />
+<meta name="twitter:card" content="summary" />
<!-- mathjax -->
-<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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>
@@ -49,6 +58,12 @@
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
+ <a href="../index.html">
+ <span class="fa fa-home fa-lg"></span>
+
+ </a>
+</li>
+<li>
<a href="../reference/index.html">Reference</a>
</li>
</ul>
@@ -73,15 +88,20 @@
<p>Download FOCUS PELMO from the official site and unzip into the package installation directory</p>
- <pre><span class='fu'>install_PELMO</span>(<span class='kw'>version</span> <span class='kw'>=</span> <span class='st'>"5.5.3"</span>, <span class='kw'>local_zip</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>
+ <pre class="usage"><span class='fu'>install_PELMO</span>(<span class='kw'>version</span> <span class='kw'>=</span> <span class='st'>"5.5.3"</span>, <span class='kw'>local_zip</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
- <dl class="dl-horizontal">
- <dt>version</dt>
- <dd>The FOCUS PELMO version to install</dd>
- <dt>local_zip</dt>
- <dd>Do not download, but use the local zip archive specified here</dd>
- </dl>
+ <table class="ref-arguments">
+ <colgroup><col class="name" /><col class="desc" /></colgroup>
+ <tr>
+ <th>version</th>
+ <td><p>The FOCUS PELMO version to install</p></td>
+ </tr>
+ <tr>
+ <th>local_zip</th>
+ <td><p>Do not download, but use the local zip archive specified here</p></td>
+ </tr>
+ </table>
</div>
@@ -100,7 +120,7 @@
</div>
<div class="pkgdown">
- <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+ <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>

Contact - Imprint