|
16 | 16 | </p>
|
17 | 17 |
|
18 | 18 |
|
19 |
| -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 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](https://bioconda.github.io), [Bioconductor](https://www.bioconductor.org), [BioTools](https://github.com/bio-tools), and [ToolShed](https://toolshed.g2.bx.psu.edu). |
| 19 | +The objective of this project is to study the impact of publishing tools |
| 20 | +to package management systems on their scholarly recognition and adoption. |
| 21 | +For instance, how much the citation count of a scholarly paper increase after its |
| 22 | +respective software is added to Bioconductor. Currently, the study is |
| 23 | +focused on tools published to package management systems primarily used |
| 24 | +by the Bioinformatics community: |
| 25 | +[Bioconda](https://bioconda.github.io), |
| 26 | +[Bioconductor](https://www.bioconductor.org), |
| 27 | +[BioTools](https://github.com/bio-tools), and |
| 28 | +[ToolShed](https://toolshed.g2.bx.psu.edu). |
20 | 29 |
|
21 |
| -The study is performed using the following components: |
| 30 | +## Project Structure |
22 | 31 |
|
23 |
| -- [TVQ Service](https://github.com/Genometric/TVQ/tree/master/webservice/WebService). A containerized ASP.NET Web application. This service collects the data required for the study; it crawls Bioconda, Bioconductor, BioTools, and ToolShed for all the packages they host and collects their metadata such as tool name, scholarly references, and date added to the package management system. It then queries the Scopus for the citation count of the scholarly references of each tool. |
| 32 | +The project consists of three major components (see the following figure): |
24 | 33 |
|
25 |
| -- [Python Scripts](https://github.com/Genometric/TVQ/tree/master/analytics) for statistical analysis and plotting. These scripts perform statistical tests on the data collected by the TVQ Service and report results in tables and plots. |
| 34 | +- [**Offline Crawlers**](https://genometric.github.io/TVQ/docs/offline_crawlers/about): |
| 35 | +Scripts to retrieve those package metadata that require |
| 36 | +extensive time or resource consuming operations. These scripts are not run frequently, |
| 37 | +and their generated data is cached under the |
| 38 | +[`data`](https://github.com/Genometric/TVQ/tree/master/data) |
| 39 | +folder to be used by the _Webservice_ |
| 40 | +(read [details]((https://genometric.github.io/TVQ/docs/offline_crawlers/about))). |
26 | 41 |
|
| 42 | +- [**Webservice**](https://genometric.github.io/TVQ/docs/webservice/about): |
| 43 | +Collects all the required metadata about software packages, it uses the cached |
| 44 | +data and queries the package management systems for the "cheap-to-retrieve" data. |
| 45 | +It then aggregates the information collected from different package management systems, |
| 46 | +and queries Scopus for the citation count of every scholarly paper. The service |
| 47 | +generates descriptive statistics about the packages and their citation count, and |
| 48 | +outputs raw data to be used for detailed statistical inferences by _analytical scripts_ |
| 49 | +(read webservice [details](https://genometric.github.io/TVQ/docs/webservice/about)). |
27 | 50 |
|
28 |
| -## Contributing |
| 51 | +- [**Analytics Scripts**](): |
| 52 | +[Python Scripts](https://github.com/Genometric/TVQ/tree/master/analytics) |
| 53 | +for statistical analysis and plotting. These scripts perform statistical tests |
| 54 | +on the data collected by the _webservice_ and report results in tables and plots |
| 55 | +(read [detail](https://genometric.github.io/TVQ/docs/analytics/about) about |
| 56 | +these scripts). |
| 57 | + |
| 58 | +<p align="center"> |
| 59 | + <a href="https://genometric.github.io/TVQ/docs/"> |
| 60 | + <img src="https://raw.githubusercontent.com/Genometric/TVQ/docs/static/img/overview.svg?raw=true" alt="TVQ" /> |
| 61 | + </a> |
| 62 | +</p> |
| 63 | + |
| 64 | + |
| 65 | +## 💖 Contributing |
29 | 66 |
|
30 | 67 | When it comes to open-source, every contribution you
|
31 | 68 | make, makes the software better for everyone, and
|
|
0 commit comments