| Type: | Package |
| Title: | Analyse Text Files Created by Emacs' Org mode |
| Version: | 0.9.0 |
| Date: | 2014-12-15 |
| Author: | Yi Tang |
| Maintainer: | Yi Tang <yi.tang.uk@me.com> |
| Description: | Provides functionality to process text files created by Emacs' Org mode, and decompose the content to the smallest components (headlines, body, tag, clock entries etc). Emacs is an extensible, customizable text editor and Org mode is for keeping notes, maintaining TODO lists, planning projects. Allows users to analyze org files as data frames in R, e.g., to convieniently group tasks by tag into project and calculate total working hours. Also provides some help functions like search.parent, gg.pie (visualise working hours in ggplot2) and tree.headlines (visualise headline stricture in tree format) to help user managing their complex org files. |
| License: | GPL-2 | GPL-3 [expanded from: GPL (≥ 2)] |
| Depends: | ggthemes (≥ 1.7.0), ggplot2 (≥ 1.0.0), lubridate(≥ 1.3.3), data.table (≥ 1.9.4), stringr (≥ 0.6.2) |
| Packaged: | 2014-12-19 15:02:11.908 UTC; yitang |
| NeedsCompilation: | no |
| Repository: | CRAN |
| Date/Publication: | 2014-12-20 07:48:40 |
clock.table
Description
Parse org file
Usage
GetClockTable(org.file = "~/tmp.org")
Arguments
org.file |
a org file |
Details
scan a org file and return the headlines and associated clock entries
Value
a data.table
Author(s)
Yi Tang
Headlines
Description
org headlines
Usage
GetHeadlines(org.file = "~/tmp.org")
Arguments
org.file |
a file path point to a .org file |
Details
A function to parse org files, will return headlines and associated attributes, including tag, clock entries, shedules, deadlines, closed date, todo states,
Value
a table of headlines and attributes
Author(s)
Yi Tang
function
Description
ad descrition
Usage
GetTS(str = "a", ts.format = c("<%Y-%m-%d %a>",
"<%Y-%m-%d %a %H:%M>"))
Arguments
str |
content of a .org file |
ts.format |
format of time stamps used in the .org file. It is equivalent to |
Details
lalla details
Value
a
Author(s)
yitang
clock.table
Description
Parse clock entry to ISO date
Usage
ToISOdate(clock.entries)
Arguments
clock.entries |
a standard clock entry from org-mode |
Value
POXICt object
Author(s)
Yi Tang
Examples
str <- c("CLOCK: [2014-11-26 Wed 09:36]--[2014-11-26 Wed 10:04] => 0:28",
"CLOCK: [2014-12-04 Thu 15:24]--[2014-12-04 Thu 16:25] => 1:01")
ToISOdate(str)
orgR
Description
orgR
Details
a package to process org file
Author(s)
yitang
search.parent
Description
Search for parent headlines
Usage
search.parent(head.info, heading.id)
Arguments
head.info |
a head table from GetHeadlings |
heading.id |
a unique id from head.info |
Details
Given a headlines table and headline id, it will return the parent headlines.
Value
a data.table
Author(s)
Yi Tang
org-headings-tree
Description
Visualise org-mode headings
Usage
tree.headings(head.info, output = "screen", plantuml = TRUE)
Arguments
head.info |
a data.tabl returned by GetHeadlines() |
output |
file to save the results, default setting is to print to scree |
plantuml |
TRUE/FALSE, for plantuml program? |
Details
tree structure of org headlines
Value
a string that can be used in plantuml program
Author(s)
Yi Tang