README.md

In jennybc/excelgesis: Access and Edit XML Inside xlsx

excelgesis

The goal of excelgesis is to make the XML files inside Excel’s .xlsx files navigable in a web browser. It’s a helper package for the development and debugging of readxl. excelgesis itself is intended for strictly for personal, diagnostic, and recreational use.

Despite zero planning on my part, it works equally well for other Office Open XML File Formats, like Word and PowerPoint. A happy fact pointed out to me on Twitter.

You can explore some unpacked Excel workbooks here, drawn from the readxl example and test sheets:

https://jennybc.github.io/excelgesis/

Those same workbooks are available in .xlsx form in the excelgesis package. Use xg_example() to gain access.

The definitive reference for .xlxs is Standard ECMA-376 Office Open XML File Formats:

• http://www.ecma-international.org/publications/standards/Ecma-376.htm

Installation

You can install excelgesis from github with:

# install.packages("devtools")
devtools::install_github("jennybc/excelgesis")

Usage

List the included examples.

library(excelgesis)
xg_example()
#> Available examples:
#>   * Ekaterinburg_IP_9.xlsx
#>   * big-texty-numbers-xlsx.xlsx
#>   * blanks.xlsx
#>   * clippy.xlsx
#>   * datasets.xlsx
#>   * dates-1900-LibreOffice.xlsx
#>   * dates-leap-year-1900-xlsx.xlsx
#>   * datetime-rounding.xlsx
#>   * deaths.xlsx
#>   * embedded-chartsheet.xlsx
#>   * empty-named-column.xlsx
#>   * empty-sheets.xlsx
#>   * geometry.xlsx
#>   * inlineStr.xlsx
#>   * inlineStr2.xlsx
#>   * iris-excel-xlsx.xlsx
#>   * iris-google-doc.xlsx
#>   * list_type.xlsx
#>   * los-angeles-arrests-xlsx.xlsx
#>   * missing-first-column.xlsx
#>   * missing-values-xlsx.xlsx
#>   * new_line_errors.xlsx
#>   * no-yes-col-names.xlsx
#>   * nonstandard-xml-ns-prefix.xlsx
#>   * numbers-as-na-and-shared-strings-xlsx.xlsx
#>   * richtext-coloured.xlsx
#>   * sheet-xml-lookup.xlsx
#>   * skipping.xlsx
#>   * style-only-cells.xlsx
#>   * texty-dates-xlsx.xlsx
#>   * type-me.xlsx
#>   * types.xlsx
#>   * unnamed-duplicated-columns.xlsx
#>   * utf8-sheet-names.xlsx
#>   * vietnamese-utf8.xlsx
#>   * whitespace-xlsx.xlsx

Browse around the underlying XML inside those xlsx workbooks:

https://jennybc.github.io/excelgesis/

Here’s how to do the same locally for the example workbook about Clippy:

xg_example("clippy") %>%
  fs::file_copy(new_path = ".") %>% 
  xg_inspect()
#> Unpacked these files:
#>   * ./clippy/[Content_Types].xml
#>   * ./clippy/_rels/.rels
#>   * ./clippy/xl/_rels/workbook.xml.rels
#>   * ./clippy/xl/workbook.xml
#>   * ./clippy/xl/sharedStrings.xml
#>   * ./clippy/xl/theme/theme1.xml
#>   * ./clippy/xl/styles.xml
#>   * ./clippy/xl/worksheets/sheet1.xml
#>   * ./clippy/docProps/thumbnail.jpeg
#>   * ./clippy/docProps/core.xml
#>   * ./clippy/docProps/app.xml
#> Linkifying:
#>   * ./clippy/
#> Visit this file in a browser:
#>   * clippy/index.html

In an interactive session, clippy’s landing page will open in your browser for XML browsing fun times.

The convenience function xg_inspect() wraps up three operations:

• Unzip the ZIP archive – xg_unzip()
• Make the unpacked files more pleasant for browsing – xg_linkify()
• Visit the top-level ‘index.html’ in your default browser – xg_browse()

Here’s one last worked example using the individual functions.

(mg <- xg_example("datasets"))
#> [1] "/Users/jenny/resources/R/library/excelgesis/extdata/datasets.xlsx"
mg %>% 
  fs::file_copy(new_path = ".") %>% 
  xg_unzip() %>% 
  xg_linkify() %>% 
  xg_browse()
#> Unpacked these files:
#>   * ./datasets/_rels/.rels
#>   * ./datasets/[Content_Types].xml
#>   * ./datasets/docProps/core.xml
#>   * ./datasets/docProps/app.xml
#>   * ./datasets/xl/printerSettings/printerSettings1.bin
#>   * ./datasets/xl/printerSettings/printerSettings3.bin
#>   * ./datasets/xl/sharedStrings.xml
#>   * ./datasets/xl/worksheets/_rels/sheet3.xml.rels
#>   * ./datasets/xl/worksheets/_rels/sheet4.xml.rels
#>   * ./datasets/xl/worksheets/sheet2.xml
#>   * ./datasets/xl/_rels/workbook.xml.rels
#>   * ./datasets/xl/printerSettings/printerSettings2.bin
#>   * ./datasets/xl/printerSettings/printerSettings4.bin
#>   * ./datasets/xl/styles.xml
#>   * ./datasets/xl/theme/theme1.xml
#>   * ./datasets/xl/workbook.xml
#>   * ./datasets/xl/worksheets/_rels/sheet1.xml.rels
#>   * ./datasets/xl/worksheets/sheet1.xml
#>   * ./datasets/xl/worksheets/_rels/sheet2.xml.rels
#>   * ./datasets/xl/worksheets/sheet3.xml
#>   * ./datasets/xl/worksheets/sheet4.xml
#> Linkifying:
#>   * ./datasets/
#> Visit this file in a browser:
#>   * datasets/index.html

You haven’t really seen iris or mtcars until you’ve seen them as XML.

jennybc/excelgesis documentation built on July 29, 2023, 4:31 a.m.