Skip to content

Commit

Permalink
Update README.jmd
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaodaigh authored Nov 27, 2020
1 parent de045b9 commit ed4268c
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.jmd
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ An eclectic collection of convenience functions for your data manipulation needs

### Piping Convenience

#### Re-exporting Lazy.jl's `@>` `@>>` `@as` for piping convenenice
Lazy.jl has some macros for piping operations. However, it also exports the `groupby` function which conflicts with `DataFrames.groupby`. I have made it easier here so that `using DataConvenience` will only export the macros `@>`, `@>>`, `@as`. You can achieve the same with just Lazy.jl by doing `using Lazy: @>, @>>, @as`.

#### Defining `filter(::AbstractDataFrame, arg)`
DataFrames.jl does not define `filter(::AbstractDataFrame, arg)` and instead has `filter(arg, ::AbstractDataFrame)` only. This makes it inconsistent with the other functions so that's why I am defining `filter` with the signature `filter(::AbstractDataFrame, arg)`.

Expand All @@ -29,6 +26,8 @@ end

```

Note: DataConvenience.jl used to re-export Lazy.jl's `@>` which it no longer does. Users are encouraged to use [Chain.jl](https://github.com/jkrumbiegel/Chain.jl) instead.

### Sampling with `sample`

You can conveniently sample a dataframe with the `sample` method
Expand Down

0 comments on commit ed4268c

Please sign in to comment.