ASReview has support for extensions, which enable you to seemlessly integrate your own programs with the ASReview framework. This template can extent ASReview with new data.
See the section Extensions on ReadTheDocs for more information on writing extensions.
Click the Use this template
button and add/modify the algorithms. Install your
new dataset with
pip install .
or
pip install git+https://github.com/{USER_NAME}/{REPO_NAME}.git
and replace {USER_NAME}
and {REPO_NAME}
by your own details.
Adding a dataset to ASReview is done by extending the
BaseDataSet
class, and adding it to ASReview. To use this template, fork it and modify the
following files:
-
A BaseDataSet object is defined in
asreviewcontrib/dataset_name/your_dataset.py
. Modify the path and this file to add your own dataset. -
Adding your BaseDataSet object to ASReview is done via the
asreviewcontrib/dataset_name/__init__.py
file. This file should import your new class -
Adjust
setup.py
with information about your dataset, and define the dataset entrypoint. -
Add your dataset to the
data
folder of the template.
For advanced usage- (e.g. adding multiple groups), check out the
BaseDataGroup
in the example and at the documentation.
MIT license