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

Jump to bottom

update describe, unique and nonunique docs #2652

Merged
merged 6 commits into from
Mar 14, 2021
Merged

update describe, unique and nonunique docs #2652

merged 6 commits into from
Mar 14, 2021

Conversation

bkamins
Copy link
Member

@bkamins bkamins commented Mar 11, 2021

Fixes #2651

@bkamins bkamins added the doc label Mar 11, 2021
@bkamins bkamins added this to the 1.0 milestone Mar 11, 2021
@bkamins bkamins mentioned this pull request Mar 11, 2021
Open
nalimilan
nalimilan reviewed Mar 11, 2021
View reviewed changes
src/abstractdataframe/abstractdataframe.jl Outdated Show resolved Hide resolved
src/abstractdataframe/abstractdataframe.jl Outdated Show resolved Hide resolved
src/abstractdataframe/abstractdataframe.jl Outdated
@@ -1187,8 +1188,9 @@ See also [`unique`](@ref) and [`unique!`](@ref).

# Arguments
- `df` : `AbstractDataFrame`
- `cols` : a selector specifying the column(s) to compare. Can be any column
selector ($COLUMNINDEX_STR; $MULTICOLUMNINDEX_STR).
- `cols` : a selector specifying the column(s) to compare using
Copy link
Member

Choose a reason for hiding this comment

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

Also mention transformations (here and below)?

@pdeffebach
Copy link
Contributor

Just to confirm, changing describe at this point, to do descibe(df, :x, :y, funs = ...) is a no-go?

@bkamins
Copy link
Member Author

bkamins commented Mar 11, 2021

changing describe at this point, to do descibe(df, :x, :y, funs = ...) is a no-go?

I would say so. Also note that you can always write describe(select(df, ...), ...).

@pdeffebach
Copy link
Contributor

Perhaps a summarize method can be added in DataFramesMeta to alleviate this.

@nalimilan
Copy link
Member

Perhaps a summarize method can be added in DataFramesMeta to alleviate this.

Please don't! We managed to keep the API relatively small so that it's easy to master, and we've almost reached the goal to have a parallel between DataFrames functions and DataFramesMeta macros. Also summarize is used in dplyr for something totally different.

For reference, the previous discussion was at #2385.

@pdeffebach
Copy link
Contributor

Sounds good! Thankfully we can export the @col macro in DataFramesMeta to make those transformations really seamless even if they are in a keyword argument.

bkamins and others added 3 commits March 12, 2021 16:56
nalimilan
nalimilan approved these changes Mar 13, 2021
View reviewed changes
src/abstractdataframe/abstractdataframe.jl Outdated Show resolved Hide resolved
@bkamins @nalimilan
Apply suggestions from code review
74b8f3a 
Co-authored-by: Milan Bouchet-Valat <nalimilan@club.fr>
@bkamins bkamins merged commit 4d98798 into main Mar 14, 2021
@bkamins bkamins deleted the bk/unique_docs branch March 14, 2021 10:10
@bkamins
Copy link
Member Author

bkamins commented Mar 14, 2021

Thank you!

@pdeffebach pdeffebach mentioned this pull request Mar 18, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nalimilan nalimilan nalimilan approved these changes

Assignees
No one assigned
Labels
doc
Projects
None yet
Milestone
1.0
Development

Successfully merging this pull request may close these issues.

add predicate/transformation version of unique?
3 participants
@bkamins @pdeffebach @nalimilan