ngds / ADEPT_frontend

The front-end environment for the ADEPT project.
MIT License
0 stars 0 forks source link

Documentation for Dictionaries Tab #22

Closed aazaff closed 3 years ago

aazaff commented 3 years ago

The following is a draft set of the "help"/"instructions" for the Dictionaries tab of ADEPT

ABOUT

A dictionary is a list of keywords that can be used to identify sets of xDD documents that contain one or more of the listed keywords. Users must contact the xDD administrative team (contact@geodeepdive.org) to create dictionaries with more complex set logic, such as "includes X and Y, but excludes Z".

View Existing Dictionaries

Users can view a list of pre-made dictionaries offered by the xDD team by clicking the All button. Many of these dictionaries were created for specific projects and are unlikely to hold terms of interest to other users, but users can click the Filtered button to see a curated list of dictionaries that is more likely to be generally useful.

Local Dictionaries

Users can also create new, custom dictionaries through the ADEPT interface by clicking the Local button and filling out the resulting form. A dictionary made through this method is private and only visible to the user who created it from this pane. A user can request a test set (e.g., a random sample of 200 documents containing one or more of the keywords in the dictionary) for any local, user-created dictionary. A URL to the requested test-set will be accessible by navigating to the Test Set tab.