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
Update the Dataset Reference: The correct command, as informed by the ASReview support team, should be asreview data dedup synergy:van_de_schoot_2018 -o van_de_schoot_2018_dedup.csv.
Note on Datatools Version: It might be beneficial to add a note about ensuring that the datatools package is up to date. A simple command like pip install asreview-datatools --upgrade can be suggested to prevent potential issues with executing the dedup command.
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.
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 isasreview 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
asreview data dedup synergy:van_de_schoot_2018 -o van_de_schoot_2018_dedup.csv
.pip install asreview-datatools --upgrade
can be suggested to prevent potential issues with executing thededup
command.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.