mirror of
https://github.com/agdamsbo/stRoke.git
synced 2024-11-23 13:30:22 +01:00
184 lines
14 KiB
HTML
184 lines
14 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>MOVED Write ical object — write_ical • 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="MOVED Write ical object — write_ical"><meta name="description" content="This function creates an ical file based on a data frame with mixed events.
|
||
Export as .ics file using calendar::ic_write()."><meta property="og:description" content="This function creates an ical file based on a data frame with mixed events.
|
||
Export as .ics file using calendar::ic_write()."><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>MOVED Write ical object</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/stRoke/blob/v24.10.1/R/write_ical.R" class="external-link"><code>R/write_ical.R</code></a></small>
|
||
<div class="d-none name"><code>write_ical.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<p>This function creates an ical file based on a data frame with mixed events.
|
||
Export as .ics file using <code><a href="https://atfutures.github.io/calendar/reference/ic_write.html" class="external-link">calendar::ic_write()</a></code>.</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">write_ical</span><span class="op">(</span></span>
|
||
<span> <span class="va">df</span>,</span>
|
||
<span> date <span class="op">=</span> <span class="st">"date"</span>,</span>
|
||
<span> date.end <span class="op">=</span> <span class="cn">NA</span>,</span>
|
||
<span> title <span class="op">=</span> <span class="st">"title"</span>,</span>
|
||
<span> time.start <span class="op">=</span> <span class="st">"start"</span>,</span>
|
||
<span> time.end <span class="op">=</span> <span class="st">"end"</span>,</span>
|
||
<span> place <span class="op">=</span> <span class="cn">NA</span>,</span>
|
||
<span> place.def <span class="op">=</span> <span class="cn">NA</span>,</span>
|
||
<span> time.def <span class="op">=</span> <span class="st">"10:00:00"</span>,</span>
|
||
<span> time.dur <span class="op">=</span> <span class="fl">60</span>,</span>
|
||
<span> descr <span class="op">=</span> <span class="cn">NA</span>,</span>
|
||
<span> link <span class="op">=</span> <span class="cn">NA</span>,</span>
|
||
<span> t.zone <span class="op">=</span> <span class="st">"CET"</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-df">df<a class="anchor" aria-label="anchor" href="#arg-df"></a></dt>
|
||
<dd><p>A data frame with the calendar data</p></dd>
|
||
|
||
|
||
<dt id="arg-date">date<a class="anchor" aria-label="anchor" href="#arg-date"></a></dt>
|
||
<dd><p>The name of the event date column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-date-end">date.end<a class="anchor" aria-label="anchor" href="#arg-date-end"></a></dt>
|
||
<dd><p>The name of the end date column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
|
||
<dd><p>The name of the title column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-time-start">time.start<a class="anchor" aria-label="anchor" href="#arg-time-start"></a></dt>
|
||
<dd><p>The name of the start time column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-time-end">time.end<a class="anchor" aria-label="anchor" href="#arg-time-end"></a></dt>
|
||
<dd><p>The name of the end time column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-place">place<a class="anchor" aria-label="anchor" href="#arg-place"></a></dt>
|
||
<dd><p>The name of the place column in the data frame</p></dd>
|
||
|
||
|
||
<dt id="arg-place-def">place.def<a class="anchor" aria-label="anchor" href="#arg-place-def"></a></dt>
|
||
<dd><p>Default location to use when place is NA</p></dd>
|
||
|
||
|
||
<dt id="arg-time-def">time.def<a class="anchor" aria-label="anchor" href="#arg-time-def"></a></dt>
|
||
<dd><p>Default start time to use when time.start is NA</p></dd>
|
||
|
||
|
||
<dt id="arg-time-dur">time.dur<a class="anchor" aria-label="anchor" href="#arg-time-dur"></a></dt>
|
||
<dd><p>Default duration of the event in minutes, if time.end is NA</p></dd>
|
||
|
||
|
||
<dt id="arg-descr">descr<a class="anchor" aria-label="anchor" href="#arg-descr"></a></dt>
|
||
<dd><p>Name of description/notes column if any.</p></dd>
|
||
|
||
|
||
<dt id="arg-link">link<a class="anchor" aria-label="anchor" href="#arg-link"></a></dt>
|
||
<dd><p>Name of link column, if any.</p></dd>
|
||
|
||
|
||
<dt id="arg-t-zone">t.zone<a class="anchor" aria-label="anchor" href="#arg-t-zone"></a></dt>
|
||
<dd><p>A character string of time zone for events. The string must be
|
||
a time zone that is recognized by the user's OS.</p></dd>
|
||
|
||
</dl></div>
|
||
<div class="section level2">
|
||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||
<p>ical object</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
|
||
<div class="dont-index"><p><a href="https://github.com/ATFutures/calendar/" class="external-link">calendar package</a>
|
||
<a href="https://icalendar.org" class="external-link">icalendar standard webpage</a></p></div>
|
||
</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"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span></span></span>
|
||
<span class="r-in"><span> date <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">"2020-02-10"</span>, <span class="st">"2020-02-11"</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> date.end <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">"2020-02-13"</span>,<span class="cn">NA</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> title <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">"Conference"</span>, <span class="st">"Lunch"</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="st">"12:00:00"</span>, <span class="cn">NA</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> time.end <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">"13:00:00"</span>, <span class="cn">NA</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><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="st">"Hi there"</span>,<span class="st">"Remember to come"</span><span class="op">)</span>,</span></span>
|
||
<span class="r-in"><span> link <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">"https://icalendar.org"</span>,<span class="st">"https://agdamsbo.github.io/stRoke/"</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span></span></span>
|
||
<span class="r-in"><span><span class="fu">write_ical</span><span class="op">(</span></span></span>
|
||
<span class="r-in"><span> <span class="va">df</span>,</span></span>
|
||
<span class="r-in"><span> date <span class="op">=</span> <span class="st">"date"</span>,</span></span>
|
||
<span class="r-in"><span> date.end <span class="op">=</span> <span class="st">"date.end"</span>,</span></span>
|
||
<span class="r-in"><span> title <span class="op">=</span> <span class="st">"title"</span>,</span></span>
|
||
<span class="r-in"><span> time.start <span class="op">=</span> <span class="st">"start"</span>,</span></span>
|
||
<span class="r-in"><span> time.end <span class="op">=</span> <span class="st">"time.end"</span>,</span></span>
|
||
<span class="r-in"><span> place.def <span class="op">=</span> <span class="st">"Conference Room"</span>,</span></span>
|
||
<span class="r-in"><span> descr <span class="op">=</span> <span class="st">"note"</span>,</span></span>
|
||
<span class="r-in"><span> link <span class="op">=</span> <span class="st">"link"</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 2 × 7</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> SUMMARY DTSTART DTEND UID LOCATION URL </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><chr></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 style="color: #949494; font-style: italic;"><chr></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> Conference 2020-02-10 <span style="color: #949494;">12:00:00</span> 2020-02-13 <span style="color: #949494;">13:00:00</span> ical-6c018f… Confere… http…</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> Lunch 2020-02-11 <span style="color: #949494;">10:00:00</span> 2020-02-11 <span style="color: #949494;">11:00:00</span> ical-acc32d… Confere… http…</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># ℹ 1 more variable: DESCRIPTION <chr></span></span>
|
||
<span class="r-in"><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>
|
||
|