ual-re / figstats Goto Github PK

The Figshare stats API is available at: https://stats.figshare.com

We want a class with the following methods:

• get_totals: Total stats (views, downloads, shares) either for article, author, collection, group, or project
  • get_user_totals: Calls get_totals to retrieve for author
• get_timeline: Retrieve timeline of views, downloads, and shares
• get_figshare_id: Retrieve Figshare profile ID
• retrieve_institution_users: Retrieve institutional accounts
• retrieve_institution_articles: Retrieve institutional public articles
• get_institution_totals: Retrieve total views, downloads, and shares for articles or authors

While this issue focuses on the API, the best demonstration test of it is done through visualization. As such we need:

• A visualization module with
  • plot_timeline method to illustrate timeline using an appropriate date axis style
  • plot_shares to overlay share data
  • A make_timeline_plots script to run for an institution