Reference#

dibisoplot#

DataStatus(*values)

Status of the data.

Dibisoplot(entity_id[, year, ...])

Base class for generating plots and tables from data fetched from various APIs.

Dibisoplot.__init__(entity_id[, year, ...])

Initialize the Biso class with the given parameters.

Dibisoplot.generate_plot_info([...])

Generate the plot info.

Dibisoplot.get_no_data_plot()

Create the error plot.

Dibisoplot.get_error_plot()

Create the error plot.

Dibisoplot.get_no_data_latex()

Create the error LaTeX code.

Dibisoplot.get_error_latex()

Create the error LaTeX code.

Dibisoplot.dataframe_to_longtable(table_df)

Convert a pandas DataFrame to LaTeX longtable code without document headers.

Dibisoplot.get_figure()

Generate a bar plot based on the fetched data.

Biso#

Biso.__init__(entity_id[, year, ...])

Initialize the Biso class with the given parameters.

Biso.get_all_ids_with_cursor([id_type])

Get all DOI articles using cursor pagination

Biso.connect_to_elasticsearch()

Connect to Elasticsearch using the provided credentials.

Biso.get_works_from_es_index_from_id(index, ids)

Get works by their id from an elasticsearch index.

Biso.get_works_from_es_index_from_id_and_private_sector(...)

Get works which are from the private sector by their id from an elasticsearch index.

Biso.get_works_from_es_index_from_id_by_chunk(...)

Get works by their id from an elasticsearch index by chuncks.

AnrProjects.__init__(entity_id[, year])

Initialize the AnrProjects class.

AnrProjects.fetch_data()

Fetch data about ANR projects from the HAL API.

Chapters.__init__(entity_id[, year])

Initialize the Chapters class.

Chapters.fetch_data()

Fetch data about book chapters from the HAL API.

Chapters.get_figure()

Generate a LaTeX longtable of book chapters.

CollaborationMap.__init__(entity_id[, year, ...])

Initialize the CollaborationMap class.

CollaborationMap.fetch_data()

Fetch data about collaborations from the HAL API and OpenAlex API.

CollaborationMap.get_figure()

Plot a map with the number of collaborations per institution.

CollaborationNames.__init__(entity_id[, ...])

Initialize the CollaborationNames class.

CollaborationNames.fetch_data()

Fetch data about collaboration names from the HAL API only.

Conferences.__init__(entity_id[, year])

Initialize the Conferences class.

Conferences.fetch_data()

Fetch data about conferences from the HAL API.

EuropeanProjects.__init__(entity_id[, year])

Initialize the EuropeanProjects class.

EuropeanProjects.fetch_data()

Fetch data about European projects from the HAL API.

Journals.__init__(entity_id[, year])

Initialize the Journals class.

Journals.fetch_data()

Fetch data about journals from the API.

Journals.get_figure()

Generate a LaTeX longtable of journals.

JournalsHal.__init__(entity_id[, year])

Initialize the JournalsHal class.

JournalsHal.fetch_data()

Fetch data about Journals from the HAL API.

OpenAccessWorks.__init__(entity_id[, year, ...])

Initialize the OpenAccessWorks class.

OpenAccessWorks.fetch_data()

Fetch data about open access works from the HAL API.

OpenAccessWorks.get_figure()

Plot the open access status of works.

PrivateSectorCollaborations.__init__(entity_id)

Initialize the PrivateSectorCollaborations class.

PrivateSectorCollaborations.fetch_data()

Fetch data about PrivateSectorCollaborations from the API.

WorksBibtex.fetch_data()

Fetch the data from HAL and convert it to bibtex.

WorksBibtex.get_figure()

Generate a LaTeX bibtex file.

WorksType.__init__(entity_id[, year])

Initialize the WorksType class.

WorksType.fetch_data()

Fetch data about work types from the HAL API.

PubPart#

PubPart.__init__(entity_id[, year, ...])

Initialize the Biso class with the given parameters.

PubInstitutions.__init__(entity_id[, year, ...])

Initialize the PubInstitutions class.

PubInstitutions.fetch_data()

Fetch data about collaborations from OpenAlex

PubTopics.fetch_data()

Fetch data about topics from OpenAlex

Collaborations.__init__(entity_id[, year, ...])

Initialize the TopicsPotentialCollaborations class.

Collaborations.fetch_collab_data()

Fetch data for plots about collaborations.

InstitutionsLineageCollaborations.fetch_data()

Fetch data about institutions in the lineage from OpenAlex

TopicsCollaborations.fetch_data()

Fetch data about topics of collaborations from OpenAlex

TopicsPotentialCollaborations.fetch_data()

Fetch data about topics of collaborations from OpenAlex

WorksCollaborations.__init__(entity_id[, ...])

Initialize the WorksCollaborations class.

WorksCollaborations.fetch_data()

Fetch data about co-publications from OpenAlex

translation#

get_translator([domain, language, locale_dir])

Initialize and return a gettext translation function for the specified domain and language.

utils#

get_hal_doc_type_name(name)

get_empty_plot_with_message(message)

Create an empty plot with a message.

get_empty_latex_with_message(message)

Create an empty plot with a message.

get_bar_width(n_bars)

Calculate the width of bars in a plot based on the number of bars.

format_structure_name(struct_name, country_code)

Format the structure name by cropping if too long and adding a country flag.