-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README to incorporate some more useful information.
- Loading branch information
1 parent
546c0b3
commit 3ccfa69
Showing
2 changed files
with
26 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters