mirror of
https://github.com/agdamsbo/stRoke.git
synced 2024-11-23 13:30:22 +01:00
137 lines
13 KiB
HTML
137 lines
13 KiB
HTML
<!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, shrink-to-fit=no"><title>Convert data set to ical file — ds2ical • stRoke</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Convert data set to ical file — ds2ical"><meta name="description" content="Convert data set to ical file"><meta property="og:description" content="Convert data set to ical file"><meta property="og:image" content="https://agdamsbo.github.io/stRoke/logo.png"></head><body>
|
||
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
||
|
||
|
||
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
|
||
|
||
<a class="navbar-brand me-2" href="../index.html">stRoke</a>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.10.1</small>
|
||
|
||
|
||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
||
<span class="navbar-toggler-icon"></span>
|
||
</button>
|
||
|
||
<div id="navbar" class="collapse navbar-collapse ms-3">
|
||
<ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
||
<li class="nav-item dropdown">
|
||
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
||
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/toolbox.html">Toolbox</a></li>
|
||
</ul></li>
|
||
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
|
||
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
|
||
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
|
||
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/agdamsbo/stRoke/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
|
||
</ul></div>
|
||
|
||
|
||
</div>
|
||
</nav><div class="container template-reference-topic">
|
||
<div class="row">
|
||
<main id="main" class="col-md-9"><div class="page-header">
|
||
<img src="../logo.png" class="logo" alt=""><h1>Convert data set to ical file</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/stRoke/blob/main/R/ds2ical.R" class="external-link"><code>R/ds2ical.R</code></a></small>
|
||
<div class="d-none name"><code>ds2ical.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<p>Convert data set to ical file</p>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ds2ical</span><span class="op">(</span></span>
|
||
<span> <span class="va">data</span>,</span>
|
||
<span> start <span class="op">=</span> <span class="va">start</span>,</span>
|
||
<span> end <span class="op">=</span> <span class="va">end</span>,</span>
|
||
<span> location <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||
<span> summary.glue.string <span class="op">=</span> <span class="st">"ID {id} [{assessor}]"</span>,</span>
|
||
<span> description.glue.string <span class="op">=</span> <span class="cn">NULL</span></span>
|
||
<span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
||
|
||
|
||
<dl><dt id="arg-data">data<a class="anchor" aria-label="anchor" href="#arg-data"></a></dt>
|
||
<dd><p>data set</p></dd>
|
||
|
||
|
||
<dt id="arg-start">start<a class="anchor" aria-label="anchor" href="#arg-start"></a></dt>
|
||
<dd><p>dplyr style event start datetime column name. Data or datetime
|
||
object.</p></dd>
|
||
|
||
|
||
<dt id="arg-end">end<a class="anchor" aria-label="anchor" href="#arg-end"></a></dt>
|
||
<dd><p>dplyr style event end datetime column name. Data or datetime
|
||
object.</p></dd>
|
||
|
||
|
||
<dt id="arg-location">location<a class="anchor" aria-label="anchor" href="#arg-location"></a></dt>
|
||
<dd><p>dplyr style event location column name</p></dd>
|
||
|
||
|
||
<dt id="arg-summary-glue-string">summary.glue.string<a class="anchor" aria-label="anchor" href="#arg-summary-glue-string"></a></dt>
|
||
<dd><p>character string to pass to glue::glue() for event
|
||
name (summary). Can take any column from data set.</p></dd>
|
||
|
||
|
||
<dt id="arg-description-glue-string">description.glue.string<a class="anchor" aria-label="anchor" href="#arg-description-glue-string"></a></dt>
|
||
<dd><p>character string to pass to glue::glue() for
|
||
event description. Can take any column from data set.</p></dd>
|
||
|
||
</dl></div>
|
||
<div class="section level2">
|
||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||
<p>tibble of class "ical"</p>
|
||
</div>
|
||
|
||
<div class="section level2">
|
||
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">df</span> <span class="op"><-</span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span></span>
|
||
<span class="r-in"><span> start <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/Sys.time.html" class="external-link">Sys.time</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span> <span class="fu">lubridate</span><span class="fu">::</span><span class="fu"><a href="https://lubridate.tidyverse.org/reference/period.html" class="external-link">days</a></span><span class="op">(</span><span class="fl">2</span><span class="op">)</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> id <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"1"</span>, <span class="fl">3</span><span class="op">)</span>, assessor <span class="op">=</span> <span class="st">"A"</span>, location <span class="op">=</span> <span class="st">"111"</span>, note <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="cn">NA</span>, <span class="st">"OBS"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>end <span class="op">=</span> <span class="va">start</span> <span class="op">+</span> <span class="fu">lubridate</span><span class="fu">::</span><span class="fu"><a href="https://lubridate.tidyverse.org/reference/period.html" class="external-link">hours</a></span><span class="op">(</span><span class="fl">2</span><span class="op">)</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="va">df</span> <span class="op">|></span> <span class="fu">ds2ical</span><span class="op">(</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 2 × 4</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> SUMMARY DTSTART DTEND UID </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><glue></span> <span style="color: #949494; font-style: italic;"><dttm></span> <span style="color: #949494; font-style: italic;"><dttm></span> <span style="color: #949494; font-style: italic;"><chr></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">1</span> ID 1 [A] 2024-10-23 <span style="color: #949494;">14:07:53</span> 2024-10-23 <span style="color: #949494;">16:07:53</span> ical-09ef2f83-9eba-4d1f-a8af…</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> ID 3 [A] 2024-10-25 <span style="color: #949494;">14:07:53</span> 2024-10-25 <span style="color: #949494;">16:07:53</span> ical-55943cb0-3cfd-43a0-9ffc…</span>
|
||
<span class="r-in"><span><span class="va">df</span> <span class="op">|></span> <span class="fu">ds2ical</span><span class="op">(</span>summary.glue.string <span class="op">=</span> <span class="st">"ID {id} [{assessor}] {note}"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 2 × 4</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> SUMMARY DTSTART DTEND UID </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><glue></span> <span style="color: #949494; font-style: italic;"><dttm></span> <span style="color: #949494; font-style: italic;"><dttm></span> <span style="color: #949494; font-style: italic;"><chr></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">1</span> ID 1 [A] 2024-10-23 <span style="color: #949494;">14:07:53</span> 2024-10-23 <span style="color: #949494;">16:07:53</span> ical-f0535f7e-0c5a-4ea6-…</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> ID 3 [A] OBS 2024-10-25 <span style="color: #949494;">14:07:53</span> 2024-10-25 <span style="color: #949494;">16:07:53</span> ical-2c246f66-2ec6-4b0d-…</span>
|
||
<span class="r-in"><span><span class="co"># Export .ics file: (not run)</span></span></span>
|
||
<span class="r-in"><span><span class="va">ical</span> <span class="op"><-</span> <span class="va">df</span> <span class="op">|></span> <span class="fu">ds2ical</span><span class="op">(</span><span class="va">start</span>, <span class="va">end</span>, <span class="va">location</span>,</span></span>
|
||
<span class="r-in"><span>description.glue.string <span class="op">=</span> <span class="st">"{note}"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="co"># ical |> calendar::ic_write(file=here::here("calendar.ics"))</span></span></span>
|
||
</code></pre></div>
|
||
</div>
|
||
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
||
</nav></aside></div>
|
||
|
||
|
||
<footer><div class="pkgdown-footer-left">
|
||
<p>Developed by Andreas Gammelgaard Damsbo.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown-footer-right">
|
||
<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>
|
||
|