Skip to content

DOC: added examples to DataFrame.var #44162 #44274

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.

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 13 commits into from
Nov 6, 2021
Merged
32 changes: 30 additions & 2 deletions pandas/core/generic.py
Original file line number Diff line number Diff line change
Expand Up @@ -10661,12 +10661,12 @@ def sem(
@doc(
_num_ddof_doc,
desc="Return unbiased variance over requested axis.\n\nNormalized by "
"N-1 by default. This can be changed using the ddof argument",
"N-1 by default. This can be changed using the ddof argument.",
name1=name1,
name2=name2,
axis_descr=axis_descr,
notes="",
examples="",
examples=_var_examples,
)
def var(
self,
Expand Down Expand Up @@ -11221,6 +11221,34 @@ def _doc_params(cls):
age 16.269219
height 0.205609"""

_var_examples = """

Examples
--------
>>> df = pd.DataFrame({'person_id': [0, 1, 2, 3],
... 'age': [21, 25, 62, 43],
... 'height': [1.61, 1.87, 1.49, 2.01]}
... ).set_index('person_id')
>>> df
age height
person_id
0 21 1.61
1 25 1.87
2 62 1.49
3 43 2.01

The variance of the columns can be found as follows:

>>> df.var()
age 352.916667
height 0.056367

Alternatively, `ddof=0` can be set to normalize by N instead of N-1:

>>> df.var(ddof=0)
age 264.687500
height 0.042275"""

_bool_doc = """
{desc}

Expand Down