Skip to content

DOC: Added examples to pandas.concat documentation #15028

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

Merged
merged 16 commits into from
Jan 4, 2017
Merged

DOC: Added examples to pandas.concat documentation #15028

Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
6c916a9
DOC: Added examples to pandas.concat documentation
palewire Jan 1, 2017
67a750c
Added ignore_index example
palewire Jan 2, 2017
2e85990
Removed pandas import from example
palewire Jan 2, 2017
709ec27
Wording change
palewire Jan 2, 2017
afa7502
Added keys example
palewire Jan 2, 2017
3887774
Added names options
palewire Jan 2, 2017
415f082
Make some fixes for @jorisvandenbossche
palewire Jan 2, 2017
40ccf8b
Removed typo
palewire Jan 2, 2017
2d83cd6
Added a simple axis=1 example
palewire Jan 2, 2017
76a9814
An example with a gap is probably better
palewire Jan 2, 2017
16b8d28
Added join examples
palewire Jan 2, 2017
f005280
Added link to walkthrough, some see also links as well as an verify i…
palewire Jan 3, 2017
7c5126f
Cleaned up axis example
palewire Jan 3, 2017
5141b46
Changes to concat docs
palewire Jan 3, 2017
c58f9f8
Corrected indentation
palewire Jan 3, 2017
780d206
correct link to tutorial docs
jorisvandenbossche Jan 4, 2017
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
54 changes: 47 additions & 7 deletions pandas/tools/merge.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1398,9 +1398,11 @@ def concat(objs, axis=0, join='outer', join_axes=None, ignore_index=False,
copy=True):
"""
Concatenate pandas objects along a particular axis with optional set logic
along the other axes. Can also add a layer of hierarchical indexing on the
concatenation axis, which may be useful if the labels are the same (or
overlapping) on the passed axis number
along the other axes.

Can also add a layer of hierarchical indexing on the concatenation axis,
which may be useful if the labels are the same (or overlapping) on
the passed axis number

Parameters
----------
Expand Down Expand Up @@ -1436,13 +1438,51 @@ def concat(objs, axis=0, join='outer', join_axes=None, ignore_index=False,
copy : boolean, default True
If False, do not copy data unnecessarily

Notes
-----
The keys, levels, and names arguments are all optional

Returns
-------
concatenated : type of objects

Notes
-----
Copy link
Contributor

Choose a reason for hiding this comment

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

if you are going to add examples, then this needs to be more complete, using examples from here:http://pandas.pydata.org/pandas-docs/stable/merging.html#concatenating-objects

certainly not all of these, but a quick selection (as well as having this link would be fine).

The keys, levels, and names arguments are all optional.

Examples
--------
Combine two ``Series``.

>>> import pandas as pd
>>> s1 = pd.Series(['a', 'b'])
Copy link
Member

Choose a reason for hiding this comment

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

no indentation is needed here for the example blocks

(and the 'import pandas as pd' can also be left out -> this is assumed)

>>> s2 = pd.Series(['c', 'd'])
>>> pd.concat([s1, s2])
0 a
1 b
0 c
1 d

Combine two ``DataFrame`` objects with identical columns.

>>> df1 = pd.DataFrame(
... [['a', 1], ['b', 2]],
... columns=['letter', 'number']
... )
>>> df1
letter number
0 a 1
1 b 2
>>> df2 = pd.DataFrame(
... [['c', 3], ['d', 4]],
... columns=['letter', 'number']
... )
>>> df2
letter number
0 c 3
1 d 4
>>> pd.concat([df1, df2])
letter number
0 a 1
1 b 2
0 c 3
1 d 4
"""
op = _Concatenator(objs, axis=axis, join_axes=join_axes,
ignore_index=ignore_index, join=join,
Expand Down