Skip to content

Commit

Permalink
Update README to incorporate some more useful information.
Browse files Browse the repository at this point in the history
  • Loading branch information
vaneseltine committed Jul 10, 2024
1 parent 546c0b3 commit 3ccfa69
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 11 deletions.
33 changes: 26 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,37 @@
# ash

Hunting the [evil dead](https://www.science.org/content/article/zombie-papers-wont-die-retracted-papers-notorious-fraudster-still-cited-years-later) in the scientific literature.
Hunting the
[evil dead](https://www.science.org/content/article/zombie-papers-wont-die-retracted-papers-notorious-fraudster-still-cited-years-later)
in the scientific literature.

This is a work in progress. Try it via:
## Usage

```
This is a work in progress. Get yourself a copy of the Retraction Watch database,
get yourself a paper with some references in it,
then try Ash.
First install:

```bash
python -m pip install ash-williams
```

And a simple use looks like:
And then something like:

```python
from ash import Paper
from pprint import pprint

import ash

paper = Paper("sample.pdf")
print(paper.report(db="./retraction_watch.csv"))
db = ash.RetractionDatabase("./retractions.csv")
paper = Paper("./manuscript.docx")
pprint(paper.report(db))
```

## Retraction Watch database

Crossref has licensed the Retraction Watch for a five-year term and are making it public
including updates, per the official announcement: https://doi.org/10.13003/c23rw1d9.
To download the latest data snapshot (~44 MB as of Jul 2024),
simply add your email address to the following URL.
The csv will automatically download:
api.labs.crossref.org/data/retractionwatch?youremailhere@example.com.
4 changes: 0 additions & 4 deletions notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,6 @@ Do we want to give...
- [ ] Server in separate repository (in progress)
- [ ] Binder/colab notebook for easy Python sampling

## Retraction Watch via Crossref

Per the official Crossref announcement -- https://doi.org/10.13003/c23rw1d9 -- to download the latest data snapshot (~44 MB as of Jul 2024), add your email address to the following: api.labs.crossref.org/data/retractionwatch?youremailhere@example.com

### API

We could alternatively hit the Crossref API with DOIs in hand
Expand Down

0 comments on commit 3ccfa69

Please sign in to comment.