| Title: | Analyse Text Files Created by Emacs' Org mode |
|---|---|
| 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. |
| Authors: | Yi Tang |
| Maintainer: | Yi Tang <[email protected]> |
| License: | GPL (>= 2) |
| Version: | 0.9.0 |
| Built: | 2024-10-31 18:36:42 UTC |
| Source: | https://github.com/cran/orgR |
Parse org file
GetClockTable(org.file = "~/tmp.org")GetClockTable(org.file = "~/tmp.org")
org.file |
a org file |
scan a org file and return the headlines and associated clock entries
a data.table
Yi Tang
org headlines
GetHeadlines(org.file = "~/tmp.org")GetHeadlines(org.file = "~/tmp.org")
org.file |
a file path point to a .org file |
A function to parse org files, will return headlines and associated attributes, including tag, clock entries, shedules, deadlines, closed date, todo states,
a table of headlines and attributes
Yi Tang
ad descrition
GetTS(str = "a", ts.format = c("<%Y-%m-%d %a>", "<%Y-%m-%d %a %H:%M>"))GetTS(str = "a", ts.format = c("<%Y-%m-%d %a>", "<%Y-%m-%d %a %H:%M>"))
str |
content of a .org file |
ts.format |
format of time stamps used in the .org file. It is equivalent to |
lalla details
a
yitang
Search for parent headlines
search.parent(head.info, heading.id)search.parent(head.info, heading.id)
head.info |
a head table from GetHeadlings |
heading.id |
a unique id from head.info |
Given a headlines table and headline id, it will return the parent headlines.
a data.table
Yi Tang
Parse clock entry to ISO date
ToISOdate(clock.entries)ToISOdate(clock.entries)
clock.entries |
a standard clock entry from org-mode |
POXICt object
Yi Tang
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)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)
Visualise org-mode headings
tree.headings(head.info, output = "screen", plantuml = TRUE)tree.headings(head.info, output = "screen", plantuml = TRUE)
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? |
tree structure of org headlines
a string that can be used in plantuml program
Yi Tang