search

datasciencecampus / pygrams

Extracts key terminology (n-grams) from any large collection of documents (>1000) and forecasts emergence
https://datasciencecampus.github.io/pygrams
Other
62 stars 23 forks source link

User guide has wrong defaults for -th and -dh #361

Closed sheepworrier closed 4 years ago

sheepworrier commented 4 years ago

Describe the bug User guide says the default for -th is text and for -dh is date, but this does not match the pygrams.py code. The -th default is abstract and there is no default for -dh. Seeing that both had a default I assumed these arguments were not mandatory and missed the line above that says they are.

Expected behavior Suggest you make the line that says they are mandatory bold and update the default values to match the script.

thanasions commented 4 years ago

Thank you for the bug issue and the suggestion. We will rectify shortly.

thanasions commented 4 years ago

It is now updated to say that abstract is the default text header and None for date header as pyGrams can also work as a keywords extractor without time series analysis. Also made clear that both fields are mandatory with bold letters. Thanks again for the valuable feedback