.. Dimensions API Lab documentation master file, created by
   sphinx-quickstart on Fri Nov 22 22:19:45 2019.

.. image:: _static/img/dimensions-header-image-jupyter.png
   :width: 100%
   :alt: Dimensions API Homepage https://www.dimensions.ai/dimensions-apis/


Welcome to the Dimensions API Lab!
==============================================

This site contains a collection of open source `Jupyter notebooks <https://jupyter.org/>`_ showing how to carry out common research data analytics tasks using the `Dimensions Analytics API <https://www.dimensions.ai/dimensions-apis/>`_.

A companion `Github repository <https://github.com/digital-science/dimensions-api-lab>`_ including the source code for the notebooks is also available. The notebooks have been optimised so to work with `Google Colab <https://colab.research.google.com/github/digital-science/dimensions-api-lab>`_ as well. 


.. important::
  The Dimensions Analytics API is not intended for bulk data or to power dashboards or other derivative products. The purpose of the API is to help support complex analytical tasks that could not otherwise be achieved through use of the Dimensions platform. For more information see also the page about `Reasonable Use <https://docs.dimensions.ai/dsl/usagepolicy.html>`_ 


.. note::
  The Dimensions Analytics API is **subscription-only**, so your Dimensions account needs to be activated for this service and is subject to restrictions on use. Please get in touch to discuss the best option for you how to get access. For one-off academic research projects we can also grant free access to our APIs. `Contact us <https://www.dimensions.ai/contact-us/>`_ 




API Cookbooks
========================


.. toctree::
   :caption: Getting Started
   :maxdepth: 1
   :glob:

   cookbooks/1-getting-started/0-Verifying-your-connection.ipynb
   cookbooks/1-getting-started/1-Using-the-Dimcli-library-to-query-the-API.ipynb
   cookbooks/1-getting-started/3-Working-with-dataframes.ipynb
   cookbooks/1-getting-started/4-Dimcli-magic-commands.ipynb
   cookbooks/1-getting-started/2-Understanding-query-results.ipynb
   cookbooks/1-getting-started/5-Deep-dive-DSL-language.ipynb
   cookbooks/1-getting-started/6-Working-with-lists.ipynb
   cookbooks/1-getting-started/7-Working-with-concepts.ipynb


.. toctree::
   :caption: Publications 
   :maxdepth: 1
   :glob:

   cookbooks/2-publications/General-statistics.ipynb
   cookbooks/2-publications/Citation-Analysis.ipynb
   cookbooks/2-publications/Which-Are-the-Journals-Citing-My-Organization.ipynb
   cookbooks/2-publications/Which-Are-the-Journals-Cited-By-My-Organization.ipynb
   cookbooks/2-publications/Extracting-authors-order.ipynb
   cookbooks/2-publications/Journal-Profile-1-Gathering-data.ipynb
   cookbooks/2-publications/Journal-Profile-2-Researchers-Impact-Metrics.ipynb
   cookbooks/2-publications/Journal-Profile-3-Funding-of-Researchers.ipynb
   cookbooks/2-publications/Journal-Profile-4-Institutions.ipynb
   cookbooks/2-publications/Journal-Profile-5-Competitive-Analysis.ipynb
   cookbooks/2-publications/Simple-topic-analysis.ipynb
   cookbooks/2-publications/Concepts-network-graph.ipynb
   cookbooks/2-publications/Rejected_Article_Tracker.ipynb


.. toctree::
   :caption: Grants 
   :maxdepth: 1
   :glob:

   cookbooks/3-grants/*

.. toctree::
   :caption: Datasets 
   :maxdepth: 1
   :glob:

   cookbooks/9-datasets/1-introducing-datasets.ipynb

.. toctree::
   :caption: Clinical Trials 
   :maxdepth: 1
   :glob:

   cookbooks/4-clinical-trials/*

.. toctree::
   :caption: Patents 
   :maxdepth: 1
   :glob:

   cookbooks/5-patents/*

.. toctree::
   :caption: Policy Documents 
   :maxdepth: 1
   :glob:

   cookbooks/6-policy-documents/*
   
   
.. toctree::
   :caption: Researchers 
   :maxdepth: 1
   :glob:

   cookbooks/7-researchers/Calculating-the-H-Index-of-a-researcher.ipynb
   cookbooks/7-researchers/Researchers-Search-tips-V2.ipynb
   cookbooks/7-researchers/Experts-search-introduction.ipynb
   cookbooks/7-researchers/funders-reviewers-identification-globally-and-among-panels.ipynb

.. toctree::
   :caption: Organizations 
   :maxdepth: 1
   :glob:

   cookbooks/8-organizations/*
   

.. toctree::
   :caption: Miscellaneous 
   :maxdepth: 1
   :glob:

   cookbooks/10-misc/*



Finding Out More
==================

Find out more about the Dimensions API with the following resources:

* The `Dimensions Search Language official documentation <https://docs.dimensions.ai/dsl>`_ is a must-read if you want to become an API guru. 
* The `API Lab Github repository <https://github.com/digital-science/dimensions-api-lab>`_ contains the source code for all the notebooks on this website, and more.  
* The `Dimensions APIs homepage <https://www.dimensions.ai/dimensions-apis/>`_  is the place to start from if you've never heard about Dimensions APIs. 


Changelog
==================

See the `CHANGELOG.md <https://github.com/digital-science/dimensions-api-lab/blob/master/CHANGELOG.md>`_ file on Github.