Metadata-Version: 2.1
Name: co-citation
Version: 0.4
Summary: Create a co-citation graph from a list of papers
Home-page: https://pypi.org/project/co-citation/
Author: Vincent Lequertier
Author-email: vi.le@autistici.org
License: UNKNOWN
Project-URL: Bug Reports, https://gitlab.com/vi.le/co-citation/-/issues
Project-URL: Documentation, http://vi.le.gitlab.io/co-citation/
Project-URL: Source, https://gitlab.com/vi.le/co-citation
Keywords: co-citation research literature-review
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5, <4
Description-Content-Type: text/markdown

<!--
SPDX-License-Identifier: GPL-3.0-only
SPDX-FileCopyrightText: 2020 Vincent Lequertier <vi.le@autistici.org>
-->

# Co-citation graph generator

[![REUSE status](https://api.reuse.software/badge/gitlab.com/vi.le/co-citation)](https://api.reuse.software/info/gitlab.com/vi.le/co-citation)
[![pipeline status](https://gitlab.com/vi.le/co-citation/badges/master/pipeline.svg)](https://gitlab.com/vi.le/co-citation/-/commits/master)
[![PyPI version](https://img.shields.io/pypi/v/co-citation.svg)](https://pypi.python.org/pypi/co-citation)

Generate a co-citation graph from an article list in two steps:

1. Get the references of each article and their corresponding journals
2. Generate the co-citation pairs and add them the graph. The weights are the
   number of times the journals are co-cited.

## Example


```python
from co_citation import CoCitation

cites = CoCitation(
    [
        "https://arxiv.org/abs/1602.05112",
    ],
    data_type="journal", # or "article", "institution"
    wait=None # None or the time to wait between requests (in seconds)
    retries=None # None or the number of retries for HTTPS requests
)
cites.write_graph_edges("graph")
cites.plot_graph(display=False, k=10)
```

## Documentation

See [the documentation](http://vi.le.gitlab.io/co-citation/).


