---
title: "parse_xlsx"
---

[< Back to Reference](../reference.qmd) | [View source](https://codeberg.org/usrbinr/tidychain/src/branch/main/R/parse_xlsx.R#L49)

# `parse_xlsx()`

Read Excel Workbook

## Usage

```r
parse_xlsx(path)
```

## Arguments

| Argument | Description |
|----------|-------------|
| `path` | Path to an .xlsx file. |

## Value

An `xlsx_workbook` object with the following slots:

**Core slots:**

- @meta: File metadata (author, dates, revision, app)

- @sheets: Sheet info (names, hidden status, named ranges)

- @chain: Calculation chain (formula creation order)

- @cells: All cell data

- @formulas: Formulas with references

- @strings: Shared strings (can detect orphaned text)

- @styles: Hidden rows/columns

- @comments: Cell comments

- @links: External file links

- @connections: Data connections

**Extended slots:**

- @tables: Table definitions

- @pivots: Pivot tables

- @charts: Charts

- @queries: Query tables

- @slicers: Slicers

- @custom: Custom XML parts

## Description

Reads an Excel workbook and parses all internal components into a unified
`xlsx_workbook` object. Access components via `@` slots.

## Examples

```r
## Not run: 
xlsx <- parse_xlsx("workbook.xlsx")

# Overview
summary(xlsx)

# Drill into components
summary(xlsx@meta)
summary(xlsx@chain)
summary(xlsx@sheets)

# Access raw data
xlsx@formulas@formulas
xlsx@cells@cells

## End(Not run)
```

