Requirements

Functional Requirements

• FR1 Submitting Papers
• FR 1.1. The system shall allow a user to upload a list of paper titles to populate the database via a .txt file.
• FR1.2. The system shall allow a user to upload a list of paper titles to populate the database via a .csv file.
• FR 1.3. The system may parse papers from an author's BibTeX file and populate the database accordingly.
• FR 1.4. The system may parse papers from an author's CV and populate the database accordingly.
• FR 1.5. The system may search for papers given the name of an author and add them to the database.

FR2 Validating Papers

• FR 2.1. The software shall detect issues with papers that have had a change in title.
• FR 2.2. The system may detect issues with papers that may be lacking citation data (i.e. fairly recently published papers, papers that haven't been found online, etc.).
• FR 2.3. The system shall allow a user to view a list of issues with papers.
• FR 2.4. The system shall allow a user the ability to identify a paper as a duplicate of an existing paper.
• FR 2.5. The system shall identify and inform users of conflicts between the titles of papers.
• FR 2.6. The system shall allow a user to determine which paper entry for a paper name should be included in the system database.
• FR 2.7. The system shall identify and inform users of an attempt to create an author with an existing name.
• FR 2.8. The system shall allow the user to handle ambiguous paper issues when scraping, like title conflicts and duplicate papers.

FR3 Gathering Paper Metadata

• FR 3.1. The system shall be able to gather a faculty member’s citation information for their paper from Google Scholar.
• FR 3.2. The system shall maintain the database and ensure that citation data for papers is regularly updated such that results on papers stay accurate.
• FR 3.3. The system shall provide the option for the user to update paper citation counts at a specified interval.
• FR 3.4. The system shall maintain historical citation count data.
• FR 3.5. The system may query Google Scholar, given a faculty member's name, populating the system database with found publications without an input file.

FR4 Editing Author Tags

• FR 4.1. The system shall allow the user to create tags (i.e. institution, academic position, research area) for authors to assist with filtering.
• FR 4.2. The system shall allow the user to assign any number of tags on an author.
• FR 4.3. The system shall allow the user to view tags that they have created for the system.

FR5 Displaying Statistics

• FR 5.1. The system shall display information for each faculty member's titles on their publications.
• FR 5.2. The system shall display information for each faculty member's citation counts on their publications.
• FR 5.3. The system shall display information for each faculty member's years on their publications.
• FR 5.4. The system shall display information for each faculty member's co-authors on their publications.
• FR 5.5. The system shall create boxplots representing each author’s full distribution of papers and their respective citation counts.
• FR 5.6. The system shall produce line graphs to evaluate an author’s trajectory through their evolving citation counts.
• FR 5.7. The system shall create visual representations showing each faculty member’s calculated h-index.
• FR 5.8. The system shall create visual representations showing each faculty member’s calculated i10-index.
• FR 5.9. The system shall present statistics of multiple faculty at the same time for comparison.
• FR 5.10. The system shall filter by the user-defined search criteria, including authors by tags and papers by year range.
• FR 5.11. The system shall filter faculty members by an inputted h-index or i10-index, using the provided value as a minimum threshold.

FR6 Exporting Data

• FR 6.1. The system shall allow a user to output relative paper/citation data to CSV files for a given author.
• FR 6.2. The system may allow a user to export visualizations of author data as images.

Non-Functional Requirements

• NF1. The deliverable shall work with full functionality for all NC State faculty members.
• NF2. The software may be scaled to include querying for faculty members at other institutions, allowing for a user to compare the contribution of different universities.
• NF3. They system shall scrape and add a paper to the database of the system in at most 10 seconds to avoid further latency issues.
• NF4. The system shall be able to store and gather author and paper data for all NC State faculty.

Constraints

• C1. The system shall be accessible with full functionality on a MacOS system through the browser.
• C2. The system developed shall spend as little as possible on third-party APIs.
• C3. The system shall run at full functionality on Google Chrome, Firefox, Safari, and Edge.