Skip to content

Latest commit

 

History

History
73 lines (60 loc) · 3.31 KB

README.md

File metadata and controls

73 lines (60 loc) · 3.31 KB

TVQ

DOI

Documentation | Quick Start | Swagger API Documentation

The objective of this project is to study the impact of publishing tools to package management systems on their scholarly recognition and adoption. For instance, how much the citation count of a scholarly paper increase after its respective software is added to Bioconductor. Currently, the study is focused on tools published to package management systems primarily used by the Bioinformatics community: Bioconda, Bioconductor, BioTools, and ToolShed.

Project Structure

The project consists of three major components (see the following figure):

  • Offline Crawlers: Scripts to retrieve those package metadata that require extensive time or resource consuming operations. These scripts are not run frequently, and their generated data is cached under the data folder to be used by the Webservice (read details).

  • Webservice: Collects all the required metadata about software packages, it uses the cached data and queries the package management systems for the "cheap-to-retrieve" data. It then aggregates the information collected from different package management systems, and queries Scopus for the citation count of every scholarly paper. The service generates descriptive statistics about the packages and their citation count, and outputs raw data to be used for detailed statistical inferences by analytics scripts (read webservice details).

  • Analytics Scripts: Python Scripts for statistical analysis and plotting. These scripts perform statistical tests on the data collected by the webservice and report results in tables and plots (read detail about these scripts).



💖 Contributing

When it comes to open-source, every contribution you make, makes the software better for everyone, and that is extensively valuable and warmly appreciated by the community. We have a contributing guide to help guide you.