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

[BREAKING] Make DataFrameColumns stop being an AbstractVector #2291

Merged
merged 13 commits into from
Jun 24, 2020
Merged

[BREAKING] Make DataFrameColumns stop being an AbstractVector #2291

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
29bbddc
make DataFrameColumns stop being AbstractVector
bkamins Jun 16, 2020
a994880
add tests
bkamins Jun 16, 2020
20990c8
add functionality to DataFrameCols
bkamins Jun 16, 2020
f087796
update function definitions
bkamins Jun 16, 2020
5ba91af
fix typo
bkamins Jun 16, 2020
405487f
fixes following removal of <:AbstractVector subtyping
bkamins Jun 16, 2020
b400791
fixes after code review
bkamins Jun 16, 2020
af2be96
Apply suggestions from code review
bkamins Jun 21, 2020
ce2c5be
improve docstrings and make a view when subsetting
bkamins Jun 21, 2020
7786867
fix problem with multiindex on eachcol
bkamins Jun 22, 2020
9192e15
Apply suggestions from code review
bkamins Jun 24, 2020
7c62762
update functionality after the discusssion
bkamins Jun 24, 2020
65c969d
Apply suggestions from code review
bkamins Jun 24, 2020
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
19 changes: 17 additions & 2 deletions src/abstractdataframe/iteration.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,16 @@ Base.propertynames(itr::DataFrameRows, private::Bool=false) = propertynames(pare
DataFrameColumns{<:AbstractDataFrame}

A vector-like object that allows iteration over columns of an `AbstractDataFrame`.
Indexing into `DataFrameColumns` objects using integer or symbol indices

Indexing into `DataFrameColumns` objects using integer, `Symbol` or string
returns the corresponding column (without copying).
Indexing into `DataFrameColumns` objects using multiple column selector
returns a subsetted `DataFrameColumns` object with parent being a view of the
original containg only the selected columns.

It supports most of the `AbstractVector` API. The key differences are that it is
read-only and is that the `keys` function returns a vector of `Symbol`s (and not
integers as for normal vectors).
"""
struct DataFrameColumns{T<:AbstractDataFrame}
df::T
Expand All @@ -125,6 +133,13 @@ Base.summary(io::IO, dfcs::DataFrameColumns) = print(io, summary(dfcs))

Return a `DataFrameColumns` object that is a vector-like
that allows iterating an `AbstractDataFrame` column by column.

Indexing into `DataFrameColumns` objects using integer, `Symbol` or string
returns the corresponding column (without copying).
Indexing into `DataFrameColumns` objects using multiple column selector
returns a subsetted `DataFrameColumns` object with parent being a view of the
original containg only the selected columns.

It supports most of the `AbstractVector` API. The key differences are that it is
read-only and is that the `keys` function returns a vector of `Symbol`s (and not
integers as for normal vectors).
Expand Down Expand Up @@ -178,7 +193,7 @@ Base.iterate(itr::DataFrameColumns, i::Integer=1) =
Base.@propagate_inbounds Base.getindex(itr::DataFrameColumns, idx::ColumnIndex) =
parent(itr)[!, idx]
Base.@propagate_inbounds Base.getindex(itr::DataFrameColumns, idx::MultiColumnIndex) =
eachcol(parent(itr)[!, idx])
eachcol(view(parent(itr), !, idx))
Base.:(==)(itr1::DataFrameColumns, itr2::DataFrameColumns) =
parent(itr1) == parent(itr2)
Base.isequal(itr1::DataFrameColumns, itr2::DataFrameColumns) =
Expand Down