Skip to content

Latest commit

 

History

History
executable file
·
72 lines (40 loc) · 2.92 KB

Documentation.md

File metadata and controls

executable file
·
72 lines (40 loc) · 2.92 KB
Raw

#Documentation This is the documentation of the python package scientometric-graph-tool.

Index

A graph-tool primer

Modules

multiplex_structures

citation_net

##A graph-tool Primer To understand the scientometric-graph-tool package it is import to have a working understanding of graph-tool. Of course, the best way to gain this is to read through the documentation of graph-tool here. However, here you can find a little primer in order to have the basics covered and to better understand scientometric-graph-tool.

More to come ...

##Modules Documentation for the several modules within this package.

###multiplex_structures ####PaperAuthorMultiplex A class for network multiplex's of paper citation networks and collaboration networks.

.add_paper(self,paper_id,year,author_list,update_collaborations=True)

Add a paper with paper_id (str), publication year (int) and authors specified in author_list (list) to the multiplex. Collaborations are automatically updated, unless otherwise specified.

.add_citation(self,cited_paper,citing_paper)

Add citation between two papers in the citation network.

.add_collaboration(self,author1, author2, year)

Add collaboration between two authors, without adding a paper.

.read_graphml(self,collab_file,citation_file,mult_file)

Read multiplex from files (graphml format) specifying the collaboration network, the citation network and multiplex meta data (csv).

.papers_by(self,author_id)

Returns a list of paper (citation) vertex objects that specified author has (co)authored.

.authors_of(self,paper_id)

Returns a list of author (collaboration) vertex objects that have (co)authored the specified paper.

.socially_biased_citations(self)

Calculate number of socially-biased citations for every paper. Defined as the number of citations, that are citations by people who have, at the time of citing the paper, previously collaborated with the authors.

###citation_net ####PaperCitationNet A class for paper citation networks.

.read_graphml(self,citation_file,citation_meta)

Reads a paper citation network from citation_file in .graphml format. Metadata, like publication year, has to be given in citation_meta csv file.

####MolloyReedCitationInstance(PaperCitationNetInstance) A derived class from PaperCitationNet. Every instance is a citation-shuffled version of PaperCitationNetInstance. Through inheritance, has all methods of PaperCitationNet()