Quantopian's community platform is shutting down. Please read this post for more information and download your code.

Back to Community

Dividend Class Factor Help

posted May 13, 2017

Seeking Help Getting Started Tools and Tips numpy/pandas

I am trying to buy the highest dividend in each sector. I do not know why this code will not work. I have tried it after I have ran the pipeline, and it will work. I cannot keep the ticker index name though when I do it that way.

I would like to know a better way to display my class factor.

# highest dividend in the sector

class sector_div(CustomFactor):
window_length=1
inputs= [morningstar.valuation_ratios.dividend_yield,morningstar.asset_classification.morningstar_sector_code]
def compute(self, today, assets, out, div, sector):
df = pd.DataFrame(index=assets, data={"div": div,
"sector":sector})
best_sector = df.groupby(['sector'], as_index=False)["div"].max()
best_sector = best_sector.drop('sector', axis=1)
out[:]= best_sector

1 response

You don't really need to create a custom factor for this. Use the 'top' method and set the ' groupby' parameter. (see https://www.quantopian.com/help#quantopian_pipeline_factors_Factor)

# First probably create a filter returning the universe of stocks we want to look at  
universe = Q1500US()

# Make a classifier which returns the sector for each security  
sector = Sector()

# Make a factor which returns the dividend yield for each security  
dividend_yield = morningstar.valuation_ratios.dividend_yield.latest

# Create a filter returning only the top 1 highest dividend yield securities from each sector  
top_dividend_yield = dividend_yield.top(1, mask=universe, groupby=sector)


# Now define a pipline with each of these factors and filters as columns  
pipe = Pipeline(  
            columns = {  
            'dividend_yield' : dividend_yield,  
            'sector' : sector,  
            },  
            screen = top_dividend_yield)

Attached is a notebook showing how this works. You can also get the top n securities (eg the top 5) simply by changing the 'top' parameter.

You've successfully submitted a support ticket.

Our support team will be in touch soon.

Need help? Contact support.

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian.

In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.

About Quantopian

The material on this website is provided for informational purposes only and does not constitute an offer to sell, a solicitation to buy, or a recommendation or endorsement for any security or strategy, nor does it constitute an offer to provide investment advisory services by Quantopian.

In addition, the material offers no opinion with respect to the suitability of any security or specific investment. No information contained herein should be regarded as a suggestion to engage in or refrain from any investment-related course of action as none of Quantopian nor any of its affiliates is undertaking to provide investment advice, act as an adviser to any plan or entity subject to the Employee Retirement Income Security Act of 1974, as amended, individual retirement account or individual retirement annuity, or give advice in a fiduciary capacity with respect to the materials presented herein. If you are an individual retirement or other investor, contact your financial advisor or other fiduciary unrelated to Quantopian about whether any given investment idea, strategy, product or service described herein may be appropriate for your circumstances. All investments involve risk, including loss of principal. Quantopian makes no guarantees as to the accuracy or completeness of the views expressed in the website. The views are subject to change, and may have become unreliable for various reasons, including changes in market conditions or economic circumstances.