asreview / asreview-datatools

Tool to preprocess datasets for ASReview
MIT License
19 stars 13 forks source link

Add API documentation #15

Open J535D165 opened 2 years ago

J535D165 commented 2 years ago

The datatools package has an intuitive API. At the moment, only the CLI is documented. We are welcoming contributions to the documentation that describe the API.

arav-k commented 2 years ago

I would like to take up this. Need more details on the same.

J535D165 commented 2 years ago

That would be nice. Please let me know if there is anything I can help with. Maybe a nice starting point is the API documentation of Insights https://github.com/asreview/asreview-insights#plotting-api. Small examples of usage.