Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Docs with latest types #813

Merged
merged 2 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ data exploration to Elixir.

Explorer high-level features are:

- Simply typed series: `:binary`, `:boolean`, `:category`, `:date`, `:datetime`,
`:duration`, floats (`:f32` and `:f64`), `:integer`, `:string`, `:time`, and
`:list`
- Simply typed series: `:null`, `:binary`, `:boolean`, `:category`, `:date`, `:datetime`,
`:duration`, floats of 32 and 64 bits (`{:f, size}`), integers of 8, 16, 32 and 64 bits (`{:s, size}`, `{:u, size}`), `:string`, `:time`, `:list` and `:struct`.

- A powerful but constrained and opinionated API, so you spend less time looking
for the right function and more time doing data manipulation.
Expand Down
9 changes: 6 additions & 3 deletions notebooks/exploring_explorer.livemd
Original file line number Diff line number Diff line change
Expand Up @@ -112,17 +112,20 @@ DataFrame.to_csv(df, filename)

`Explorer` supports the following `Series` `dtypes`:

* `:null` - Null
* `:binary` - Binaries (sequences of bytes)
* `:boolean` - Boolean
* `:category` - Strings but represented internally as integers
* `:date` - Date type that unwraps to `Elixir.Date`
* `{:datetime, precision}` - DateTime type with millisecond/microsecond/nanosecond precision that unwraps to `Elixir.NaiveDateTime`
* `{:duration, precision}` - Duration type with millisecond/microsecond/nanosecond precision that unwraps to `Explorer.Duration`
* `{:f, 32}` - 32-bit floating point number
* `:float` or `{:f, 64}` - 64-bit floating point number.
* `:integer` - 64-bit signed integer
* `{:f, size}` - a 32-bit or 64-bit floating point number
* `{:s, size}` - a 8-bit or 16-bit or 32-bit or 64-bit signed integer
* `{:u, size}` - a 8-bit or 16-bit or 32-bit or 64-bit unsigned integer
* `:string` - UTF-8 encoded binary
* `:time` - Time type that unwraps to `Elixir.Time`
* `:list` - a nested data type like `Elixir.List`. It is a sequence of values having the same data type.
* `:struct` - a nested data type like a `Elixir.Map`, but with the same keys and matching data types.

`Series` can be constructed from Elixir basic types. For example:

Expand Down
Loading