read_mbox: Converting an mbox file into a tibble data_frame.

View source: R/read_mbox.R

read_mboxR Documentation

Converting an mbox file into a tibble data_frame.

Description

Use this function for importing and converting an mbox file into a tibble object.

Usage

read_mbox(mbox = NULL, file = NULL)

Arguments

mbox

Input mbox file.

file

Output RDS file if you want to save. The default is NULL, which is not saving the output as a file.

Details

read_mbox

See example below.

Value

Tibble object for the input mbox file will be returned.

Author(s)

JooYoung Seo, jooyoung@psu.edu

Soyoung Choi, sxc940@psu.edu

References

https://en.wikipedia.org/wiki/Mbox

https://docs.python.org/3/library/mailbox.html

https://www.anaconda.com/download/

Examples


# Changing working directory to temp for the demonstration purpose only.
withr::with_tempdir(code = {
  library(mboxr)
  # Feeding an mbox file through read_mbox function:
  test <- system.file("extdata", "test1.mbox", package = "mboxr")
  data <- read_mbox(mbox = test, file = "output.rds")
  # Now you can use the imported file as a tibble.
  str(data)
})



jooyoungseo/mboxr documentation built on Jan. 26, 2025, 4 p.m.