Skip to content

Commit

Permalink
Added refs
Browse files Browse the repository at this point in the history
  • Loading branch information
TheRoniOne committed Feb 5, 2022
1 parent 14409bc commit 01c4cfa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,16 @@ e.g: `missing`, `""`, `"NA"`, `"None"`
- Drop rows with missing values.
- Add a row index to your table.
- 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`](@ref) implements the [Tables.jl](https://github.com/JuliaData/Tables.jl) interface too.
- Apply `Cleaner` transformations on your original table implementation and have the resulting table be of the same type as the original.
- Get all repeated values or value combinations that are supposed to be unique.
- Get the percentage distribution of the different categories that make up your table.
- Compare tables to help solve `join` or `merge` problems caused by having different schemas.

### 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`](@ref).
All mutating functions (those ending with a `!`) recieve a [`CleanTable`](@ref) and return a [`CleanTable`](@ref).
All returning original type function variants (those ending with ROT) recieve a `table` as argument and return a `table` of the same type of the original.

So you can start your workflow with a non mutating function and continue using mutating ones.
Expand Down

2 comments on commit 01c4cfa

@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 created: JuliaRegistries/General/53993

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 v1.0.1 -m "<description of version>" 01c4cfa53ec238f17a50ed9ed80c1aadb95fbc24
git push origin v1.0.1

Please sign in to comment.