API reference

This page provides the API documentation of litstudy. All public functions are re-exported under the global litstudy namespace for convenience. However, the code is structured hierachical meaning the documentation shows the hierarchical names. For example:

docs = litstudy.sources.scopus.search_scopus("example")
litstudy.plot.plot_author_histogram(docs)

# Is equivalent to

docs = litstudy.search_scopus("example")
litstudy.plot_author_histogram(docs)

The package is divided into 6 modules:

• Core data types such as Document and DocumentSet.

• Functions to retrieve or load scientific citations.

• Compute general statistics.

• Generate bibliographic networks.

• Automatic topic detection using natural language processing (NLP).

• Plot results. These functions are mostly useful inside a notebook.

Contents

• Data Types
  • DocumentSet
  • DocumentIdentifier
  • Document
  • Affiliation
  • Author
• Literature Databases
  • Scopus
  • SemanticScholar
  • CrossRef
  • CSV
  • IEEE Xplore
  • Springer Link
  • bibtex
  • RIS
  • dblp
  • arXiv
• Calculating Statistics
  • compute_year_histogram()
  • compute_number_authors_histogram()
  • compute_language_histogram()
  • compute_source_histogram()
  • compute_source_type_histogram()
  • compute_author_histogram()
  • compute_author_affiliation_histogram()
  • compute_affiliation_histogram()
  • compute_country_histogram()
  • compute_continent_histogram()
• Network Analysis
  • plot_network()
  • build_citation_network()
  • plot_citation_network()
  • build_cocitation_network()
  • plot_cocitation_network()
  • build_coupling_network()
  • plot_coupling_network()
  • build_coauthor_network()
  • plot_coauthor_network()
• Language Processing
  • Corpus
  • build_corpus()
  • TopicModel
  • train_nmf_model()
  • train_lda_model()
  • train_elda_model()
  • compute_word_distribution()
  • generate_topic_cloud()
  • calculate_embedding()
• Plotting Statistics
  • plot_histogram()
  • plot_year_histogram()
  • plot_author_histogram()
  • plot_number_authors_histogram()
  • plot_author_affiliation_histogram()
  • plot_language_histogram()
  • plot_source_histogram()
  • plot_source_type_histogram()
  • plot_affiliation_histogram()
  • plot_country_histogram()
  • plot_continent_histogram()
  • plot_word_distribution()
  • plot_embedding()
  • plot_topic_clouds()
  • plot_topic_cloud()