An open API service indexing awesome lists of open source software.

https://github.com/linsalrob/comparereferences

Compare References from Google Scholar and ORCID
https://github.com/linsalrob/comparereferences

Last synced: 12 months ago
JSON representation

Compare References from Google Scholar and ORCID

Awesome Lists containing this project

README

          

[![Edwards Lab](https://img.shields.io/badge/Bioinformatics-EdwardsLab-03A9F4)](https://edwards.sdsu.edu/research)
[![DOI](https://www.zenodo.org/badge/440388622.svg)](https://www.zenodo.org/badge/latestdoi/440388622)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![GitHub language count](https://img.shields.io/github/languages/count/linsalrob/PyFBA)

# CompareReferences
Compare References from two different sources.

# Why?

We often need to compare references from two different sources to make sure we are upto
date. This is trivial and annoying, until you get a couple of hundred references!

Here is a simple python applet to compare the references for you.

# How?

In this example, we will compare references from Google Scholar and ORCID. However,
you are not limited to those two services, you can use anything, you just need to
download the references as `bibtex` format files, which is a widely used
reference format.

## Step 1. Download your Google Scholar references
1. Log into your Google Account and head to [Google Scholar](https://scholar.google.com/)
2. Check the box in the toolbar shown below. This activates a "hidden" menu:

[![Google Scholar Toolbar](images/gs1.png)](https://scholar.google.com)
3. The new menu will appear:

[![Google Scholar Toolbar with Export Options](images/gs2.png)](https://scholar.google.com/)
4. Choose `EXPORT` and then select `BIBTEX` from the pulldown options:

![Google Scholar Export Options](images/gs3.png)
5. Choose `Export all my articles` from the menu, and then click the export button:

![Google Scholar Export All Articles](images/gs4.png)
6. On the next page, right click and choose `Save As`:

![Google Scholar Export All Articles](images/gs5.png)
7. Save this as a file somewhere you will remember!

## Step 2. Download your ORCID references
1. Log into your [ORC-ID](https://orcid.org/) page
2. Scroll down until you see `Works`:

![ORCID Works](images/orcid1.png)
3. Check the box next to `Select All`:

![ORCID checkbox](images/orcid2.png)
4. Choose `Export all works` from the `Actions` pop up menu:

![ORCID checkbox](images/orcid3.png)
5. And then choose `Export selected works to BibTex` from the bottom of the next page:

![ORCID checkbox](images/orcid4.png)
6. This will download a file, which by default is called `works.bib`

## Compare the References

You can either download and run the executable, or download this Git repository
and install the modules.

### Use the prebuilt executable

This is the easiest way, just download the appropriate executable and use it!

### Use the repository

This is the safest way, because you can see the code you are running!

To download the repository follow these simple steps:

```bash
git clone https://github.com/linsalrob/CompareReferences.git
cd CompareReferences
python3.9 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
python3 src/CompareReferences.py
```

Either way, you will have the window open to read Google Scholar and ORCID files.

1. Read your Google Scholar file. Choose read Google Scholar from the top menu:

![Import GS](images/cr1.png)
2. Once you have read that, the button will be inactive and you will see how many references were read from that file.
Click on the Read ORCID file to do the same for ORCID:

![Import GS](images/cr2.png)
3. Once you have read both files, you will see the number of references in each and the
comparison buttons will be available:

![Import GS](images/cr3.png)

1. `Compare Both` lists references unique to Google and then references in ORCID
2. `Google Not ORCID` lists the references unique to Google
3. `ORCID Not Google` lists the references unique to ORCID
4. You can copy and paste the references, or edit them in this text box

## Now what?

You will notice that we match references by their titles, and try some (but not much)
fuzzy matching. However, we are not perfect at matching and would rather tell you
some citations that maybe different but are not.

I recommend having the two bibtex files open in a text editor, and then going down
the list of unique citations and looking to see if you can find it, or something similar,
in the bibtex file. Often, I search for a unique name or abbreviation. Most of the time,
especially for older papers, the difference is subtle, sometimes punctuation or a word like
`survey` in one citation that is `analysis` in another.

However, often a paper is missing and so you need to add that to the appropriate repository.
Sometimes, of course, (especially with Google), there are papers by other authors
that have crept into your list and shouldn't be there. Tsk, tsk!

You can delete and edit things in the text viewer, but please note that this field is not
saved, so any changes will be lost to the ether!

Sometimes, like the one shown in this final image, it is a biorXiv paper.

![biorXiv rules and should always be included](images/cr4.png)