README.md

# Xlsxplorer

`Xlsxplorer`. Load data from your .xlsx file into an `Explorer.DataFrame`.

Uses `Xlsxir` to parse data from an .xlsx file,
which is loaded into an `Explorer.DataFrame`

## Installation

The package can be installed
by adding `xlsxplorer` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:xlsxplorer, "~> 0.1.0"}
  ]
end
```

Documentation generated with [ExDoc](https://github.com/elixir-lang/ex_doc).
The docs can be found at <https://hexdocs.pm/xlsxplorer>.

## Usage
Provides a single function `from_xlsx/2` wich
loads data from a .xlsx file into an `Explorer.DataFrame`
- `path` is a string with the path to the .xlsx file
- `index` is the sheet number to be read
   from the .xlsx file into the `Explorer.DataFrame`.

## Example

```elixir
iex(1)> Xlsxplorer.from_xlsx("./test/data/example.xlsx", 0)
#Explorer.DataFrame<
Polars[2 x 2]
number integer [1, 2]
string string ["hello", "world"]
>
```