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.

Sign up for GitHub

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

fix typo in @orderby docstring #402

Merged
merged 1 commit into from
Sep 17, 2024
Merged

fix typo in @orderby docstring #402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/macros.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@

### Examples

```jldoctest

Check failure on line 862 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:862-953

```jldoctest
julia> using DataFramesMeta, Statistics

julia> df = DataFrame(x = 1:3, y = [2, 1, 2]);

julia> globalvar = [2, 1, 0];

julia> @subset(df, :x .> 1)
2×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     2      1
   2 │     3      2

julia> @subset(df, :x .> globalvar)
2×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     2      1
   2 │     3      2

julia> @subset df begin
           :x .> globalvar
           :y .== 3
       end
0×2 DataFrame

julia> df = DataFrame(n = 1:20, x = [3, 3, 3, 3, 1, 1, 1, 2, 1, 1,
                                    2, 1, 1, 2, 2, 2, 3, 1, 1, 2]);

julia> g = groupby(df, :x);

julia> @subset(g, :n .> mean(:n))
8×2 DataFrame
 Row │ n      x
     │ Int64  Int64
─────┼──────────────
   1 │    12      1
   2 │    13      1
   3 │    15      2
   4 │    16      2
   5 │    17      3
   6 │    18      1
   7 │    19      1
   8 │    20      2

julia> @subset g begin
           :n .> mean(:n)
           :n .< 20
       end
7×2 DataFrame
 Row │ n      x
     │ Int64  Int64
─────┼──────────────
   1 │    12      1
   2 │    13      1
   3 │    15      2
   4 │    16      2
   5 │    17      3
   6 │    18      1
   7 │    19      1

julia> df = DataFrame(a = [1, 2, missing], b = ["x", "y", missing]);

julia> @subset(df, :a .== 1)
1×2 DataFrame
 Row │ a       b
     │ Int64?  String?
─────┼─────────────────
   1 │      1  x

julia> @subset(df, :a .< 3; view = true)
2×2 SubDataFrame
 Row │ a       b
     │ Int64?  String?
─────┼─────────────────
   1 │      1  x
   2 │      2  y

julia> @subset df begin
           :a .< 3
           @kwarg view = true
       end
2×2 SubDataFrame
 Row │ a       b
     │ Int64?  String?
─────┼─────────────────
   1 │      1  x
   2 │      2  y
```

Subexpression:

@subset df begin
    :x .> globalvar
    :y .== 3
end

Evaluated output:

0×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┴──────────────

Expected output:

0×2 DataFrame


  diff = 
    Warning: Diff output requires color.
    0×2 DataFrameDataFrame
     Row │ x      y
         │ Int64  Int64
    ─────┴──────────────
julia> using DataFramesMeta, Statistics

julia> df = DataFrame(x = 1:3, y = [2, 1, 2]);
Expand Down Expand Up @@ -975,7 +975,7 @@
Use this function as an alternative to placing the `.` to broadcast row-wise operations.

### Examples
```jldoctest

Check failure on line 978 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:978-1008

```jldoctest
julia> using DataFramesMeta

julia> df = DataFrame(A=1:5, B=["apple", "pear", "apple", "orange", "pear"])
5×2 DataFrame
 Row │ A      B
     │ Int64  String
─────┼───────────────
   1 │     1  apple
   2 │     2  pear
   3 │     3  apple
   4 │     4  orange
   5 │     5  pear

julia> @rsubset df :A > 3
2×2 DataFrame
 Row │ A      B
     │ Int64  String
─────┼───────────────
   1 │     4  orange
   2 │     5  pear

julia> @rsubset df :A > 3 || :B == "pear"
3×2 DataFrame
  Row │ A      B
      │ Int64  String
 ─────┼───────────────
    1 │     2  pear
    2 │     4  orange
    3 │     5  pear
```

Subexpression:

@rsubset df :A > 3 || :B == "pear"

Evaluated output:

3×2 DataFrame
 Row │ A      B
     │ Int64  String
─────┼───────────────
   1 │     2  pear
   2 │     4  orange
   3 │     5  pear

Expected output:

3×2 DataFrame
  Row │ A      B
      │ Int64  String
 ─────┼───────────────
    1 │     2  pear
    2 │     4  orange
    3 │     5  pear


  diff = 
    Warning: Diff output requires color.
    3×2 DataFrame
      DataFrame
     Row │ A      B
          B
         │ Int64  String
     ─────┼───────────────
        String
    ─────┼───────────────
       1 │     2  pear
        pear
       2 │     4  orange
        orange
       3 │     5  pear
julia> using DataFramesMeta

julia> df = DataFrame(A=1:5, B=["apple", "pear", "apple", "orange", "pear"])
Expand Down Expand Up @@ -1127,7 +1127,7 @@

### Examples

```jldoctest

Check failure on line 1130 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:1130-1204

```jldoctest
julia> using DataFramesMeta, Statistics

julia> df = DataFrame(x = 1:3, y = [2, 1, 2]);

julia> globalvar = [2, 1, 0];

julia> @subset!(copy(df), :x .> 1)
2×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     2      1
   2 │     3      2

julia> @subset!(copy(df), :x .> globalvar)
2×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     2      1
   2 │     3      2

julia> @subset! copy(df) begin
           :x .> globalvar
           :y .== 3
       end
0×2 DataFrame

julia> df = DataFrame(n = 1:20, x = [3, 3, 3, 3, 1, 1, 1, 2, 1, 1,
                                    2, 1, 1, 2, 2, 2, 3, 1, 1, 2]);

julia> g = groupby(copy(df), :x);

julia> @subset!(g, :n .> mean(:n))
8×2 DataFrame
 Row │ n      x
     │ Int64  Int64
─────┼──────────────
   1 │    12      1
   2 │    13      1
   3 │    15      2
   4 │    16      2
   5 │    17      3
   6 │    18      1
   7 │    19      1
   8 │    20      2

julia> g = groupby(copy(df), :x);

julia> @subset! g begin
           :n .> mean(:n)
           :n .< 20
       end
7×2 DataFrame
 Row │ n      x
     │ Int64  Int64
─────┼──────────────
   1 │    12      1
   2 │    13      1
   3 │    15      2
   4 │    16      2
   5 │    17      3
   6 │    18      1
   7 │    19      1

julia> d = DataFrame(a = [1, 2, missing], b = ["x", "y", missing]);

julia> @subset!(d, :a .== 1)
1×2 DataFrame
 Row │ a       b
     │ Int64?  String?
─────┼─────────────────
   1 │      1  x
```

Subexpression:

@subset! copy(df) begin
    :x .> globalvar
    :y .== 3
end

Evaluated output:

0×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┴──────────────

Expected output:

0×2 DataFrame


  diff = 
    Warning: Diff output requires color.
    0×2 DataFrameDataFrame
     Row │ x      y
         │ Int64  Int64
    ─────┴──────────────
julia> using DataFramesMeta, Statistics

julia> df = DataFrame(x = 1:3, y = [2, 1, 2]);
Expand Down Expand Up @@ -1264,7 +1264,7 @@
the given `DataFrame` on the result, returning a new `DataFrame`.

Inputs to `@orderby` can come in two formats: a `begin ... end` block, in which case each
line in the block is a separate ordering operation, and as mulitple
line in the block is a separate ordering operation, and as multiple
arguments. For example, the following two statements are equivalent:

```julia
Expand Down Expand Up @@ -1311,7 +1311,7 @@

### Examples

```jldoctest

Check failure on line 1314 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:1314-1386

```jldoctest
julia> using DataFramesMeta, Statistics

julia> d = DataFrame(x = [3, 3, 3, 2, 1, 1, 1, 2, 1, 1], n = 1:10,
                     c = ["a", "c", "b", "e", "d", "g", "f", "i", "j", "h"]);

julia> @orderby(d, -:n)
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1     10  h
   2 │     1      9  j
   3 │     2      8  i
   4 │     1      7  f
   5 │     1      6  g
   6 │     1      5  d
   7 │     2      4  e
   8 │     3      3  b
   9 │     3      2  c
  10 │     3      1  a

julia> @orderby(d, invperm(sortperm(:c, rev = true)))
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      9  j
   2 │     2      8  i
   3 │     1     10  h
   4 │     1      6  g
   5 │     1      7  f
   6 │     2      4  e
   7 │     1      5  d
   8 │     3      2  c
   9 │     3      3  b
  10 │     3      1  a

julia> @orderby d begin
           :x
           abs.(:n .- mean(:n))
       end
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      3  c
   9 │     3      2  b
  10 │     3      1  a

julia> @orderby d @byrow :x^2
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      1  a
   9 │     3      2  b
  10 │     3      3  c
```

Subexpression:

@orderby d begin
    :x
    abs.(:n .- mean(:n))
end

Evaluated output:

10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  d
   2 │     1      6  g
   3 │     1      7  f
   4 │     1      9  j
   5 │     1     10  h
   6 │     2      4  e
   7 │     2      8  i
   8 │     3      3  b
   9 │     3      2  c
  10 │     3      1  a

Expected output:

10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      3  c
   9 │     3      2  b
  10 │     3      1  a


  diff = 
    Warning: Diff output requires color.
    10×3 DataFrame
     Row │ x      n      c
         │ Int64  Int64  String
    ─────┼──────────────────────
       1 │     1      5  e
       d
       2 │     1      6  f
       g
       3 │     1      7  g
       f
       4 │     1      9  i
       j
       5 │     1     10  j
       h
       6 │     2      4  d
       e
       7 │     2      8  h
       i
       8 │     3      3  c
       b
       9 │     3      2  b
      c
      10 │     3      1  a

Check failure on line 1314 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:1314-1386

```jldoctest
julia> using DataFramesMeta, Statistics

julia> d = DataFrame(x = [3, 3, 3, 2, 1, 1, 1, 2, 1, 1], n = 1:10,
                     c = ["a", "c", "b", "e", "d", "g", "f", "i", "j", "h"]);

julia> @orderby(d, -:n)
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1     10  h
   2 │     1      9  j
   3 │     2      8  i
   4 │     1      7  f
   5 │     1      6  g
   6 │     1      5  d
   7 │     2      4  e
   8 │     3      3  b
   9 │     3      2  c
  10 │     3      1  a

julia> @orderby(d, invperm(sortperm(:c, rev = true)))
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      9  j
   2 │     2      8  i
   3 │     1     10  h
   4 │     1      6  g
   5 │     1      7  f
   6 │     2      4  e
   7 │     1      5  d
   8 │     3      2  c
   9 │     3      3  b
  10 │     3      1  a

julia> @orderby d begin
           :x
           abs.(:n .- mean(:n))
       end
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      3  c
   9 │     3      2  b
  10 │     3      1  a

julia> @orderby d @byrow :x^2
10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      1  a
   9 │     3      2  b
  10 │     3      3  c
```

Subexpression:

@orderby d @byrow :x^2

Evaluated output:

10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  d
   2 │     1      6  g
   3 │     1      7  f
   4 │     1      9  j
   5 │     1     10  h
   6 │     2      4  e
   7 │     2      8  i
   8 │     3      1  a
   9 │     3      2  c
  10 │     3      3  b

Expected output:

10×3 DataFrame
 Row │ x      n      c
     │ Int64  Int64  String
─────┼──────────────────────
   1 │     1      5  e
   2 │     1      6  f
   3 │     1      7  g
   4 │     1      9  i
   5 │     1     10  j
   6 │     2      4  d
   7 │     2      8  h
   8 │     3      1  a
   9 │     3      2  b
  10 │     3      3  c


  diff = 
    Warning: Diff output requires color.
    10×3 DataFrame
     Row │ x      n      c
         │ Int64  Int64  String
    ─────┼──────────────────────
       1 │     1      5  e
       d
       2 │     1      6  f
       g
       3 │     1      7  g
       f
       4 │     1      9  i
       j
       5 │     1     10  j
       h
       6 │     2      4  d
       e
       7 │     2      8  h
       i
       8 │     3      1  a
       9 │     3      2  b
      c
      10 │     3      3  cb
julia> using DataFramesMeta, Statistics

julia> d = DataFrame(x = [3, 3, 3, 2, 1, 1, 1, 2, 1, 1], n = 1:10,
Expand Down Expand Up @@ -1406,7 +1406,7 @@
Use this function as an alternative to placing the `.` to broadcast row-wise operations.

### Examples
```jldoctest

Check failure on line 1409 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:1409-1446

```jldoctest
julia> using DataFramesMeta

julia> df = DataFrame(x = [8,8,-8,7,7,-7], y = [-1, 1, -2, 2, -3, 3])
6×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     8     -1
   2 │     8      1
   3 │    -8     -2
   4 │     7      2
   5 │     7     -3
   6 │    -7      3

julia> @rorderby df abs(:x) (:x * :y^3)
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     7     -3
   2 │    -7      3
   3 │     7      2
   4 │     8     -1
   5 │     8      1
   6 │    -8     -2

julia>  @rorderby df :y == 2 ? -:x : :y
6×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     7      2
   2 │     7     -3
   3 │    -8     -2
   4 │     8     -1
   5 │     8      1
   6 │    -7      3
```

Subexpression:

@rorderby df abs(:x) (:x * :y^3)

Evaluated output:

6×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     7     -3
   2 │    -7      3
   3 │     7      2
   4 │     8     -1
   5 │     8      1
   6 │    -8     -2

Expected output:

 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     7     -3
   2 │    -7      3
   3 │     7      2
   4 │     8     -1
   5 │     8      1
   6 │    -8     -2


  diff = 
    Warning: Diff output requires color.
     6×2 DataFrame
     Row │ x      y
         │ Int64  Int64
    ─────┼──────────────
       1 │     7     -3
       2 │    -7      3
       3 │     7      2
       4 │     8     -1
       5 │     8      1
       6 │    -8     -2
julia> using DataFramesMeta

julia> df = DataFrame(x = [8,8,-8,7,7,-7], y = [-1, 1, -2, 2, -3, 3])
Expand Down Expand Up @@ -2529,7 +2529,7 @@

### Examples

```jldoctest

Check failure on line 2532 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:2532-2552

```jldoctest
julia> using DataFramesMeta;

julia> df = DataFrame(x = 1:10, y = 10:-1:1);

julia> @distinct(df, :x .+ :y)
1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10   

julia> @distinct df begin
            :x .+ :y
        end
1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10   
```

Subexpression:

@distinct(df, :x .+ :y)

Evaluated output:

1×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     1     10

Expected output:

1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10


  diff = 
    Warning: Diff output requires color.
    1×2 DataFrame
     Row │ x      y      
         y
         │ Int64  Int64  
    ─────┼───────────────
       Int64
    ─────┼──────────────
       1 │     1      1     10

Check failure on line 2532 in src/macros.jl

View workflow job for this annotation

GitHub Actions / build 

doctest failure in ~/work/DataFramesMeta.jl/DataFramesMeta.jl/src/macros.jl:2532-2552

```jldoctest
julia> using DataFramesMeta;

julia> df = DataFrame(x = 1:10, y = 10:-1:1);

julia> @distinct(df, :x .+ :y)
1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10   

julia> @distinct df begin
            :x .+ :y
        end
1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10   
```

Subexpression:

@distinct df begin
     :x .+ :y
 end

Evaluated output:

1×2 DataFrame
 Row │ x      y
     │ Int64  Int64
─────┼──────────────
   1 │     1     10

Expected output:

1×2 DataFrame
 Row │ x      y      
     │ Int64  Int64  
─────┼───────────────
   1 │     1      10


  diff = 
    Warning: Diff output requires color.
    1×2 DataFrame
     Row │ x      y      
         y
         │ Int64  Int64  
    ─────┼───────────────
       Int64
    ─────┼──────────────
       1 │     1      1     10
julia> using DataFramesMeta;

julia> df = DataFrame(x = 1:10, y = 10:-1:1);
Expand Down
Loading