# import the dataset
from quantopian.interactive.data.accern import alphaone_free as dataset

# or if you want to import the paid dataset, use:
# from quantopian.interactive.data.accern import alphaone

# import data operations
from odo import odo
# import other libraries we will use
import pandas as pd
import matplotlib.pyplot as plt

# Let's use blaze to understand the data a bit using Blaze dshape()
dataset.dshape

# And how many rows are there?
# N.B. we're using a Blaze function to do this, not len()
dataset.count()

# Let's see what the data looks like. We'll grab the first three rows.
dataset[:3]

"""
Explanation: Accern: Alpha One
In this notebook, we'll take a look at Accern's Alpha One dataset, available on Quantopian. This dataset spans August 26, 2012 through the current day. It contains comprehensive sentiment analysis related to equities from 20 million+ sources.
Notebook Contents
There are two ways to access the data and you'll find both of them listed below. Just click on the section you'd like to read through.

<a href='#interactive'><strong>Interactive overview</strong></a>: This is only available on Research and uses blaze to give you access to large amounts of data. Recommended for exploration and plotting.
<a href='#pipeline'><strong>Pipeline overview</strong></a>: Data is made available through pipeline which is available on both the Research & Backtesting environment. Recommended for custom factor development and moving back & forth between research/backtesting.

Free samples and limits
One key caveat: we limit the number of results returned from any given expression to 10,000 to protect against runaway memory usage. To be clear, you have access to all the data server side. We are limiting the size of the responses back from Blaze.
There is a free version of this dataset as well as a paid one. The free sample includes data until 2 months prior to the current date.
To access the most up-to-date values for this data set for trading a live algorithm (as with other partner sets), you need to purchase acess to the full set.
With preamble in place, let's get started:
<a id='interactive'></a>
Interactive Overview
Accessing the data with Blaze and Interactive on Research
Partner datasets are available on Quantopian Research through an API service known as Blaze. Blaze provides the Quantopian user with a convenient interface to access very large datasets, in an interactive, generic manner.
Blaze provides an important function for accessing these datasets. Some of these sets are many millions of records. Bringing that data directly into Quantopian Research directly just is not viable. So Blaze allows us to provide a simple querying interface and shift the burden over to the server side.
It is common to use Blaze to reduce your dataset in size, convert it over to Pandas and then to use Pandas for further computation, manipulation and visualization.
Helpful links:
* Query building for Blaze
* Pandas-to-Blaze dictionary
* SQL-to-Blaze dictionary.
Once you've limited the size of your Blaze object, you can convert it to a Pandas DataFrames using:

from odo import odo
odo(expr, pandas.DataFrame)

To see how this data can be used in your algorithm, search for the Pipeline Overview section of this notebook or head straight to <a href='#pipeline'>Pipeline Overview</a>
End of explanation
"""


aapl = dataset[dataset.sid==24][['asof_date','article_sentiment', 'impact_score']].sort('asof_date')
# Whenever you print a Blaze Data Object, it will be truncated to ten rows.
aapl

"""
Explanation: Let's go over the columns:
- symbol: the ticker symbol of the company.
- name: the name of the company.
- asof_date: Alpha One's timestamp of delivery of article_sentiment.
- article_sentiment: a score in [-1,1] reflecting the sentiment of articles written about the company in the last day. The higher score, the more positive the outlook.
- timestamp: this is our timestamp on when we registered the data.
- impact_score: on [0,100], this is the probability that the stock price will change by more than 1% (given by: close - open / open) on the next trading day.
- sid: the equity's unique identifier. Use this instead of ticker or name. 
We've done much of the data processing for you. Fields like timestamp and sid are standardized across all our Store Datasets, so the datasets are easy to combine. We have standardized the sid across all our equity databases.
We can select columns and rows with ease. Below, we'll fetch all entries for the sid 24, which identifies AAPL. We're really only interested in the timestamp, article sentiment, and the impact score, so we'll display only those.
End of explanation
"""


aapl_sentiment = odo(aapl, pd.DataFrame)
# let's say we only want one year of data.
aapl_sentiment = aapl_sentiment[aapl_sentiment['asof_date'] <= '2013-08-26']
# suppose we want the rows to be indexed by timestamp.
aapl_sentiment.index = list(aapl_sentiment['asof_date'])
aapl_sentiment.drop('asof_date',1,inplace=True)
# display the first three rows. DataFrames, when printed, display 60 rows at a time.
aapl_sentiment[:3]

"""
Explanation: You can see that Accern collects data for every day, not just for every business day.
Let's convert aapl to a DataFrame.
End of explanation
"""


aapl_sentiment.plot(y='article_sentiment')

"""
Explanation: Let's take a look at the sentiment in a chart
End of explanation
"""


# Import necessary Pipeline modules
from quantopian.pipeline import Pipeline
from quantopian.research import run_pipeline
from quantopian.pipeline.factors import AverageDollarVolume

# For use in your algorithms
# Using the full paid dataset in your pipeline algo
# from quantopian.pipeline.data.accern import alphaone

# Using the free sample in your pipeline algo
from quantopian.pipeline.data.accern import alphaone_free

"""
Explanation: <a id='pipeline'></a>
Pipeline Overview
Accessing the data in your algorithms & research
The only method for accessing partner data within algorithms running on Quantopian is via the pipeline API. Different data sets work differently but in the case of this PsychSignal data, you can add this data to your pipeline as follows:
Import the data set here

from quantopian.pipeline.data.accern import alphaone

Then in intialize() you could do something simple like adding the raw value of one of the fields to your pipeline:

pipe.add(alphaone.impact_score.latest, 'impact_score')
End of explanation
"""


print "Here are the list of available fields per dataset:"
print "---------------------------------------------------\n"

def _print_fields(dataset):
    print "Dataset: %s\n" % dataset.__name__
    print "Fields:"
    for field in list(dataset.columns):
        print "%s - %s" % (field.name, field.dtype)
    print "\n"

for data in (alphaone_free,):
    _print_fields(data)


print "---------------------------------------------------\n"

"""
Explanation: Now that we've imported the data, let's take a look at which fields are available for each dataset.
You'll find the dataset, the available fields, and the datatypes for each of those fields.
End of explanation
"""


# Let's see what this data looks like when we run it through Pipeline
# This is constructed the same way as you would in the backtester. For more information
# on using Pipeline in Research view this thread:
# https://www.quantopian.com/posts/pipeline-in-research-build-test-and-visualize-your-factors-and-filters
pipe = Pipeline()

pipe.add(alphaone_free.impact_score.latest, 'impact_score')
pipe.add(alphaone_free.article_sentiment.latest, 'article_sentiment')

# Setting some basic liquidity strings (just for good habit)
dollar_volume = AverageDollarVolume(window_length=20)
top_1000_most_liquid = dollar_volume.rank(ascending=False) < 1000

pipe.set_screen(top_1000_most_liquid & alphaone_free.article_sentiment.latest.notnan())

# The show_graph() method of pipeline objects produces a graph to show how it is being calculated.
pipe.show_graph(format='png')

# run_pipeline will show the output of your pipeline
pipe_output = run_pipeline(pipe, start_date='2013-11-01', end_date='2013-11-25')
pipe_output

"""
Explanation: Now that we know what fields we have access to, let's see what this data looks like when we run it through Pipeline.
This is constructed the same way as you would in the backtester. For more information on using Pipeline in Research view this thread:
https://www.quantopian.com/posts/pipeline-in-research-build-test-and-visualize-your-factors-and-filters
End of explanation
"""


# This section is only importable in the backtester
from quantopian.algorithm import attach_pipeline, pipeline_output

# General pipeline imports
from quantopian.pipeline import Pipeline
from quantopian.pipeline.factors import AverageDollarVolume

# Import the datasets available
# For use in your algorithms
# Using the full paid dataset in your pipeline algo
# from quantopian.pipeline.data.accern import alphaone

# Using the free sample in your pipeline algo
from quantopian.pipeline.data.accern import alphaone_free

def make_pipeline():
    # Create our pipeline
    pipe = Pipeline()
    
    # Screen out penny stocks and low liquidity securities.
    dollar_volume = AverageDollarVolume(window_length=20)
    is_liquid = dollar_volume.rank(ascending=False) < 1000
    
    # Create the mask that we will use for our percentile methods.
    base_universe = (is_liquid)

    # Add pipeline factors
    pipe.add(alphaone_free.impact_score.latest, 'impact_score')
    pipe.add(alphaone_free.article_sentiment.latest, 'article_sentiment')

    # Set our pipeline screens
    pipe.set_screen(is_liquid)
    return pipe

def initialize(context):
    attach_pipeline(make_pipeline(), "pipeline")
    
def before_trading_start(context, data):
    results = pipeline_output('pipeline')

"""
Explanation: Taking what we've seen from above, let's see how we'd move that into the backtester.
End of explanation
"""


