Package 'ical'

Title: 'iCalendar' Parsing
Description: A simple wrapper around the 'ical.js' library executing 'Javascript' code via 'V8' (the 'Javascript' engine driving the 'Chrome' browser and 'Node.js' and accessible via the 'V8' R package). This package enables users to parse 'iCalendar' files ('.ics', '.ifb', '.iCal', '.iFBf') into lists and 'data.frames' to ultimately do statistics on events, meetings, schedules, birthdays, and the like.
Authors: Peter Meissner [aut, cre], Philipp Kewisch [cph] (Ical.js file is is licences under MPL. Source: https://github.com/mozilla-comm/ical.js)
Maintainer: Peter Meissner <[email protected]>
License: MIT + file LICENSE
Version: 0.3.0
Built: 2024-11-04 03:02:57 UTC
Source: https://github.com/petermeissner/ical

Help Index


ical_clean_ical_parsed

Description

ical_clean_ical_parsed

Usage

ical_clean_ical_parsed(ical_parsed)

Arguments

ical_parsed

data provided by ical_parse()


ical_parse

Description

Parses iCalendar format from character vector or file and returns it as a list of columns.

Parses iCalendar format from character vector or file and returns it as data.frame.

Parses all calendar data - to various formats: list, list of data.frames, object.

Parses iCalendar format from character vector or file and returns ALL data found in the calendar as tree like list called jcal format. This function is low level and expects the programmer to figure out what belongs where and how to handle things.

Parses iCalendar format from character vector or file and returns it as a list of entries.

Usage

ical_parse(file = NULL, text = NULL, simplify = TRUE)

ical_parse_df(file = NULL, text = NULL)

ical_parse_full(file = NULL, text = NULL)

ical_parse_jcal(file = NULL, text = NULL)

ical_parse_list(file = NULL, text = NULL)

Arguments

file

path to file to be read in and parsed

text

text of ical file

return_empty_rows

whether or not to filter out calendar items for which all fields are empty (NA)

Examples

# parse from character vector
char_vec <- readLines(system.file("birthdays.ics", package = "ical"))
ical_parse(text = char_vec)

# parse from file
ical_parse(file = system.file("birthdays.ics", package = "ical"))

ical_read_text

Description

Reads in text files or prepares character vectors. Either file or text have to be specified.

Usage

ical_read_text(file = NULL, text = NULL, enc = "UTF-8")

Arguments

file

a file path or connection object.

text

a character vector.

enc

encoding of the file to be read in


ical_test_files

Description

Function to get file paths to local test files included in the package.

Usage

ical_test_files(fname = NULL)

Arguments

fname

either NULL which will list files, an integer which will select file paths by index or a string which will select files via regular expression

Value

returns one or more file paths

Examples

ical_test_files()
ical_test_files(1)
ical_test_files("mini")