Skip to content

Commit

Permalink
Long short docstring (quantopian#174)
Browse files Browse the repository at this point in the history
Clarified long-short docstring in tears module for create tearsheet functions (issue quantopian#172 ).
  • Loading branch information
MichaelJMath authored and luca-s committed Jul 25, 2017
1 parent 65cac8e commit 98b997a
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions alphalens/tears.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,9 @@ def create_summary_tear_sheet(factor_data, long_short=True):
The factor quantile/bin that factor value belongs too, and (optionally) the group the
asset belongs to.
long_short : bool
Should this computation happen on a long short portfolio? if so then factor returns
will be demeaned across the factor universe
Should this computation happen on a long short portfolio? if so, then factor values
will be demeaned across the factor universe when factor weighting the portfolio.
Additionally, mean quantile returns will be demeaned across the factor universe.
"""


Expand Down Expand Up @@ -142,8 +143,9 @@ def create_returns_tear_sheet(factor_data, long_short=True, by_group=False):
The factor quantile/bin that factor value belongs too, and (optionally) the group the
asset belongs to.
long_short : bool
Should this computation happen on a long short portfolio? if so then factor returns
will be demeaned across the factor universe
Should this computation happen on a long short portfolio? if so, then factor values
will be demeaned across the factor universe when factor weighting the portfolio.
Additionally, mean quantile returns will be demeaned across the factor universe.
by_group : bool
If True, perform calcuations, and display graphs separately for
each group.
Expand Down Expand Up @@ -345,8 +347,9 @@ def create_full_tear_sheet(factor_data,
If True, perform calcuations, and display graphs separately for
each group.
long_short : bool
Should this computation happen on a long short portfolio? if so then factor returns
will be demeaned across the factor universe
Should this computation happen on a long short portfolio? if so, then factor values
will be demeaned across the factor universe when factor weighting the portfolio.
Additionally, mean quantile returns will be demeaned across the factor universe.
"""

plotting.plot_quantile_statistics_table(factor_data)
Expand Down

0 comments on commit 98b997a

Please sign in to comment.