readOrg: Read Org Tables

In enricoschumann/org: Helper Functions for Org Files

Read Org Tables

Description

Read an Org table from a file.

Usage

readOrg(file, header = TRUE, dec = ".", comment.char = "",
        encoding = "", strip.white = TRUE,
        stringsAsFactors = FALSE,
        table.name = NULL, text,
        table.missing = NULL, ...)

Arguments

file	character
header	logical
dec	character
comment.char	character
encoding	the encoding of the file
strip.white	logical
stringsAsFactors	logical: note that the default FALSE differs from read.csv
table.name	character: the name of the table to read (a regular expression)
text	character: if file is not supplied, text is read via textConnection
table.missing	what to do if a table specified by table.name is not found. Default is to return NULL. Set to string "stop" to throw an error.
...	further arguments

Details

When header is TRUE, readOrg will read the first 10 lines of the file (or the table, when table.name is specified) and try to find an org table header. Formating instructions such as <5> are discarded. Then the function uses read.csv to read the remainder of the file/table.

When table.name is specified, the function looks for a line that starts with #+NAME: <table.name> and reads the table that follows that line.

For empty files, readOrg behaves like read.csv: when completely empty, it fails; when headers are found, a zero-row data.frame is returned.

Value

A data.frame.

Author(s)

Enrico Schumann

References

Org manual https://orgmode.org/manual/index.html

See Also

read.csv

Examples

## Not run: 
## create an Org file with a table and read the table
tmp <-
"#+TITLE: A Table

Next comes a table.

#+name: test_table
| a | b |
|---+---|
| 1 | 2 |
| 3 | 4 |

That was a table.
"

fname <- tempfile("testfile", fileext = ".org")
writeLines(tmp, fname)

require("org")
readOrg(fname, table.name = "test_table")

## End(Not run)

enricoschumann/org documentation built on Feb. 3, 2024, 12:34 a.m.