/slr-helper

Primary LanguageTeX

SLR Helpers

Features

Feed it the inputs and the golden standards to output a table of the golden standards vs all the inputs.

User story

Export the bibtex entries from the queries on the different engines. Assume name query1_scopus.bib query1_springer etc. This outputs a table similar to

titledoitypekeywordquery1_scopusquery1_springer
gs1doi1confkeywordlisttruefalse

Usage

On Linux/macOS (hereby Linux) use bash=/=zsh
On Windows use linux powershell

Ensure Python 3 is installed

Enable the environment

Needs to be done once per terminal

Linux

source venv/bin/activate

Windows

venv/Scripts/Activate.ps1

To run the golden standard comparison from exported files

python src/main.py -g golden/GoldenStandardsDOI.xlsx -o output/results.xlsx -i input/scopus.bib

The inputs can take a list of inputs which will each get a column in the results.
Just replace the scopus.bib with a space separated list of .bib files. \ Golden Standards can be .xlsx or .bib.

.bib is used as it is supported and standardized across most sites and tools. .xlsx is supported for excel, more formats can be added later.

To run a query on scopus to compare with Golden Standards

python src/main.py -g golden/golden-48.bib -o output/results.xlsx -n testq1 -q 'TITLE-ABS-KEY("megamodel")'

Query should be according to the Scopus Advanced Search query format.
You can emit the query results to an .xlsx file by using the -f <filename> flag.

How to Install

Requires python3 Go to the directory of the repository

Linux

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Windows

python3 -m venv venv
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
venv/Scripts/Activate.ps1
pip install -r requirements.txt

For more info on python virtual environment

If using the query builtin

You will need an api key. You can get it here. Follow the instructions on the screen the first time the query runs.