ASReview has support for extensions, which enable you to seamlessly 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}.gitand replace {USER_NAME} and {REPO_NAME} by your own details.
Adding a dataset to ASReview is done by extending the
BaseDataSet
class, adding it to a BaseDataGroup and finally, adding it to ASReview. To use
this template, fork it and modify the following files:
-
A
BaseDataSetobject and aBaseDataGroupare defined inasreviewcontrib/dataset_name/your_dataset.py. Modify this file to add your own datasets. TheBaseDataSetclass should always be added to aBaseDataGroupobject. -
Adding your
BaseDataGroupobject to ASReview is done via theasreviewcontrib/dataset_name/__init__.pyfile. This file should import yourBaseDataGroup. -
Adjust
setup.pywith information about your dataset, and define the dataset entrypoint by adding yourBaseDataGroup. -
Add your dataset to the
datafolder of the template.
For advanced usage, check out the
BaseDataGroup
in the example and the documentation.
MIT license