Skip to content

Latest commit

 

History

History
135 lines (98 loc) · 4.07 KB

README.md

File metadata and controls

135 lines (98 loc) · 4.07 KB
Raw

Build Status

All of Plos (allofplos)

Copyright (c) 2017-2022, Public Library of Science. MIT License, see LICENSE.txt for more information.

Why allofplos?

This is for downloading/updating/maintaining a repository of all PLOS XML article files. This can be used to have a copy of the PLOS text corpus for further analysis. Use this program to download all PLOS XML article files instead of doing web scraping.

Installation instructions

This program requires Python 3.8+.

Using pip:

pip install allofplos

This should install allofplos and requirements. At this stage you are ready to go.

If you want to manually install from source (for example for development purposes), first clone the project repository:

git clone [email protected]:PLOS/allofplos.git

Install Python dependencies inside the newly created virtual environment:

pipenv install

How to run the program

Execute the following command.

python -m allofplos.update

or, if running from source:

pipenv run python -m allofplos.update

The first time it runs it will download a larger than 7 Gb zip file (allofplos.zip) with all the XML files inside. Note: Make sure that you have enough space in your device for the zip file and for its content before running this command (at least 30Gb). After this file is downloaded, it will extract its contents into the allofplos_xml directory inside your installation of allofplos.

If you want to see the directory on your file system where this is installed run

python -c "from allofplos import get_corpus_dir; print(get_corpus_dir())"

If you ever downloaded the corpus before, it will make an incremental update to the existing corpus. The script:

  • checks for and then downloads to a temporary folder individual new articles that have been published

  • of those new articles, checks whether they are corrections (and whether the linked corrected article has been updated)

  • checks whether there are VORs (Versions of Record) for uncorrected proofs in the main articles directory and downloads those

  • checks whether the newly downloaded articles are uncorrected proofs or not after all of these checks, it moves the new articles into the main articles folder.

Here’s what the print statements might look like on a typical run:

147 new articles to download.
147 new articles downloaded.
3 amended articles found.
0 amended articles downloaded with new xml.
Creating new text list of uncorrected proofs from scratch.
No new VOR articles indexed in Solr.
17 VOR articles directly downloaded.
17 uncorrected proofs updated to version of record. 44 uncorrected proofs remaining in uncorrected proof list.
9 uncorrected proofs found. 53 total in list.
Corpus started with 219792 articles.
Moving new and updated files...
164 files moved. Corpus now has 219939 articles.

How to run the tests

To run the tests, you will need to install allofplos with its testing dependencies. These testing dependencies include pytest, which we will use to run the tests.

pipenv run python -m pytest

Community guidelines

If you wish to contribute to this project please open a ticket in the GitHub repo at https://github.com/PLOS/allofplos/issues. For support requests write to [email protected]

Citing This Library

allofplos is published in the proceedings of the SciPy 2018. DOI 10.25080/Majora-4af1f417-009 refers to all versions of allofplos.

If you want to cite allofplos using Bibtex:

@InProceedings{ elizabeth_seiver-proc-scipy-2018,
  author    = { Elizabeth Seiver and M Pacer and Sebastian Bassi },
  title     = { Text and data mining scientific articles with allofplos },
  booktitle = { Proceedings of the 17th Python in Science Conference },
  pages     = { 61 - 64 },
  year      = { 2018 },
  editor    = { Fatih Akici and David Lippa and Dillon Niederhut and M Pacer },
  doi       = { 10.25080/Majora-4af1f417-009 }
}