search

ropensci / coder

Classification of Cases into Deterministic Categories
https://docs.ropensci.org/coder/
22 stars 4 forks source link

Explain triad of data #102

Closed eribul closed 4 years ago

eribul commented 4 years ago

The help file for classcodes mentions the "triad of case data, code data, and classification data." I found this to be a real "aha!" moment for understanding your package but this was the first place I saw this particular description. I think you could usefully focus more on this three-piece idea throughout the README, help files, and vignettes, with consistent terminology used throughout. Also, perhaps function and argument names could be altered/unified to reflect the trinity of information sources. I didn't find the names particularly intuitive as they are and was constantly having to reference them again when I was testing the functions.

eribul commented 4 years ago
eribul commented 4 years ago

Review: Thanks for the sufggestion! This is now better explained in the package README, DESCRIPTION, main vignette and in the manual page for categorize.