Skip to content

Commit

Permalink
Merge pull request #271 from etpinard/fix-where-macro-deprecation-war…
Browse files Browse the repository at this point in the history
…ning

Fix `@where` deprecation warning
  • Loading branch information
pdeffebach authored Jul 23, 2021
2 parents 0a41fcc + 07e26cb commit 7b3b064
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ The following macros accept `@byrow`:
* `@transform` and `@transform!`, `@select`, `@select!`, and `@combine`.
`@byrow` can be used in the left hand side of expressions, e.g.
`@select(df, @byrow z = :x * :y)`.
* `@subset`, `@subset!` and `@orderby`, with syntax of the form `@where(df, @byrow :x > :y)`
* `@subset`, `@subset!` and `@orderby`, with syntax of the form `@subset(df, @byrow :x > :y)`
* `@with`, where the anonymous function created by `@with` is wrapped in
`ByRow`, as in `@with(df, @byrow :x * :y)`.

Expand All @@ -312,7 +312,7 @@ operations, it is allowed to use`@byrow` at the beginning of a block of
operations. All transformations in the block will operate by row.

```julia
julia> @where df @byrow begin
julia> @subset df @byrow begin
:a > 1
:b < 5
end
Expand Down Expand Up @@ -446,7 +446,7 @@ functions.

Julia dplyr LINQ
---------------------------------------------
@where filter Where
@subset filter Where
@transform mutate Select (?)
@by GroupBy
groupby group_by GroupBy
Expand All @@ -470,7 +470,7 @@ df = DataFrame(a = repeat(1:5, outer = 20),

x_thread = @chain df begin
@transform(:y = 10 * :x)
@where(:a .> 2)
@subset(:a .> 2)
@by(:b, :meanX = mean(:x), :meanY = mean(:y))
@orderby(:meanX)
@select(:meanX, :meanY, :var = :b)
Expand All @@ -488,7 +488,7 @@ expression.
# a few transformations
@chain df begin
@transform(:y = 10 .* :x)
@where(:a .> 2)
@subset(:a .> 2)
@select(:a, :y, :x)
reduce(+, eachcol(_))
end
Expand Down
10 changes: 5 additions & 5 deletions src/macros.jl
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ to indicate that the anonymous function created by DataFramesMeta
to represent an operation should be applied "by-row".
If an expression starts with `@byrow`, either of the form `@byrow :y = f(:x)`
in transformations or `@byrow f(:x)` in `@orderby`, `@where`, and `@with`,
in transformations or `@byrow f(:x)` in `@orderby`, `@subset`, and `@with`,
then the anonymous function created by DataFramesMeta is wrapped in the
`DataFrames.ByRow` function wrapper, which broadcasts the function so that it run on each row.
Expand All @@ -89,7 +89,7 @@ julia> @transform(df, @byrow :c = :a * :b)
3 │ 3 7 21
4 │ 4 8 32
julia> @where(df, @byrow :a == 1 ? true : false)
julia> @subset(df, @byrow :a == 1 ? true : false)
1×2 DataFrame
Row │ a b
│ Int64 Int64
Expand All @@ -102,7 +102,7 @@ operations, it is allowed to use`@byrow` at the beginning of a block of
operations. All transformations in the block will operate by row.
```julia
julia> @where df @byrow begin
julia> @subset df @byrow begin
:a > 1
:b < 5
end
Expand Down Expand Up @@ -578,12 +578,12 @@ macro subset(x, args...)
end

"""
@where(x, args...)
@subset(x, args...)
Deprecated version of `@subset`, see `?@subset` for details.
"""
macro where(x, args...)
@warn "`@where is deprecated, use `@subset` with `@skipmissing` instead."
@warn "`@where is deprecated, use `@subset` instead."
esc(where_helper(x, args...))
end

Expand Down

0 comments on commit 7b3b064

Please sign in to comment.