Notes on Functionality documentation

[jennyhong]

Hi Hilary, I'm using Github Issues to track my experience working through https://github.com/ohtap/subcorpora-tool/wiki/Functionality

The wiki page starts with creating a run. However, to create a run, I first need to add a collection. I think it would make more sense to organize the sections more sequentially, so that the dependencies are clear.

So, going to the collections section, what format should the files be in? TXT? When adding a new collection, it's unclear which fields can be edited later.

Ok, so now I've created a collection. Now, I go back to try to create a run, but I don't have any keyword lists. Are these necessary? Can I create one without them? What are keyword lists? Ok, it looks like I can't create one without them (a warning would be nice?).

The UI for creating a keyword list could definitely be improved over adding a comma-separated list. I was a bit worried about whether leading / trailing spaces would be stripped correctly. Also, I notice in the sample walkthrough that you use wildcard *. What is the syntax for entering keywords? Some instruction would be helpful.

Now I go back to creating a collection... and now I need a metadata file. Ok, that goes back to the Collection section of the instructions. Where in the drive are metadata files? In Google Sheets, I see a Sheet named OHTAP_metadata - it has a few tabs. One tab is labeled "Interviews" and the other is labeled "Interviewees", and neither seems like the right table. Since the metadata file needs to have one row per interview per interviewee... it looks like you'd need an outer join on the two tables. Is that CSV available somewhere? I haven't found anything searching "metadata" in the drive... so I will end it here and let you know when I find it.