Skip to content

Add Usage and Alternatives sections to README#421

Open
nathanrboyer wants to merge 3 commits into
JuliaData:masterfrom
nathanrboyer:patch-1
Open

Add Usage and Alternatives sections to README#421
nathanrboyer wants to merge 3 commits into
JuliaData:masterfrom
nathanrboyer:patch-1

Conversation

@nathanrboyer

Copy link
Copy Markdown
Contributor

I think the README could use a little more advertisement up front to demonstrate why it is good.

@bkamins

bkamins commented Jun 1, 2026

Copy link
Copy Markdown
Member

Looks good. @nalimilan - could you also please have a look?

Comment thread README.md
subset(df, :a => ByRow(==(2)))

# With DataFramesMeta
@rsubset(df, :a == 2)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

remove parentheses? So it looks cleaner.

Suggested change
@rsubset(df, :a == 2)
@rsubset df :a == 2

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't personally like the whitespace-dependent syntax, but your call. I am using the same examples from https://juliadata.org/DataFramesMeta.jl/dev/#Introduction which already have parentheses, so I'd change both or neither.

Comment thread README.md
transform(df, [:a, :b] => ((x, y) -> x + y) => :c)

# With DataFramesMeta
@transform(df, :c = :a + :b)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
@transform(df, :c = :a + :b)
@transform df :c = :a + :b

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Same comment as above.

Comment thread README.md
df = DataFrame(a = [1, 2], b = [3, 4])
```

Add columns `a` and `b` together and store the result in a new column `c`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Add columns `a` and `b` together and store the result in a new column `c`.
Add columns `:a` and `:b` together and store the result in a new column `:c`.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The column's name is a regardless of the type used to store the name. I think "a" would have similar meaning if you prefer that to `a`. But I won't fight you further if you really want to use `:a`.

Comment thread README.md
which use operation pairs to define data frame manipulations,
DataFramesMeta.jl offers macro alternatives to each manipulation function,
which convert a more readable syntax into the appropriate DataFrames.jl function calls.
This syntax simplification is demonstrated with two simple examples below.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Add something how its similar to R's dplyr?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That doesn't mean anything to me, but you can include a statement like that if you wish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants