asreview / asreview-datatools

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

Update dedup command documentation for synergy dataset #40

Closed samuelfp4 closed 7 months ago

samuelfp4 commented 7 months ago

Issue Description

The documentation for the dedup command in the ASReview datatools readme currently provides outdated information regarding the dataset used for deduplication examples. The command example given is asreview data dedup benchmark:van_de_schoot_2017 -o van_de_schoot_2017_dedup.csv, which is deprecated. This may lead to confusion and errors for users attempting to follow the current instructions.

Background

I encountered an error when attempting to use the dedup command as documented. After reaching out to the ASReview support team, it was clarified that the documentation had not been updated to reflect the correct dataset. Following their guidance, I successfully used the command with my data and the synergy dataset upon updating my version of datatools.

Suggested Changes

Request

I kindly request that the documentation be updated to reflect the correct use of the dedup command with the synergy dataset and to include a reminder for users to ensure their datatools package is current.

laurens88 commented 7 months ago

Thanks @samuelfp4 I've created a pull request for you issue.

samuelfp4 commented 7 months ago

Thanks! :)