Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRoniOne committed Oct 27, 2021
1 parent c861e6f commit 2227a06
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,21 @@

### With Cleaner.jl you will be able to:

- Format column names to make them unique and fit snake_case or camelCase style.
- Format column names to make them unique and fit `snake_case` or `camelCase` style.
- Remove rows and columns with different kinds of empty values.
e.g: `missing`, `""`, `"NA"`, `"None"`
- Delete columns filled with just a constant value.
- Use a row as the names of the columns.
- Minimize the amount of element types for each column without making the column of type `Any`.
- Automatically use multiple threads if your data is big enough (and you are running `Julia` with more than 1 thread).
- Rematerialize your original source [Tables.jl](https://github.com/JuliaData/Tables.jl) type, as CleanTable implements the [Tables.jl](https://github.com/JuliaData/Tables.jl) interface too.
- Rematerialize your original source [Tables.jl](https://github.com/JuliaData/Tables.jl) type, as `CleanTable` implements the [Tables.jl](https://github.com/JuliaData/Tables.jl) interface too.

### To keep in mind

All non mutating functions (those ending without a `!`) recieve a table as argument and return a `CleanTable`.
All mutating functions (those ending with a `!`) recieve a CleanTable and return a `CleanTable`.
All non mutating functions (those ending without a `!`) recieve a `table` as argument and return a `CleanTable`.
All mutating functions (those ending with a `!`) recieve a `CleanTable` and return a `CleanTable`.

So you can start your workflow with a non mutating function and continue using mutating ones.
So you can start your workflow with a non mutating function and continue it using mutating ones if you prefer.
E.g.

```julia
Expand Down

2 comments on commit 2227a06

@TheRoniOne
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request updated: JuliaRegistries/General/47607

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.6.0 -m "<description of version>" 2227a06cfc8fc3259055ddffd9ff3f87472d6629
git push origin v0.6.0

Please sign in to comment.