statsmaths / cleanNLP

R package providing annotators and a normalized data model for natural language processing
GNU Lesser General Public License v2.1
209 stars 36 forks source link

Improved Documentation #72

Closed jamesmartherus closed 4 years ago

jamesmartherus commented 4 years ago

Some of the documentation could be more beginner friendly. For example, the output fields of cnlp_annotate() are not explained. What is upos? what is xpos? I'm happy to add to this if you think it would be useful.

statsmaths commented 4 years ago

Thanks for the feedback. It was well-timed as I was just ready to push a new release today (943e47134eafe3290cebf279ce125cf9b8389ffc and should be on CRAN soon). It is hard to be too specific in the documentation because the exact fields change based on the backend and language being used, but hopefully the new documentation under cnlp_annotate is what you are looking for, as well as the (now) properly linked Vignettes.