search

ropensci / coder

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

Default index message #100

Closed eribul closed 4 years ago

eribul commented 4 years ago

I noticed that when the default categorization was used, a nice message was printed in the R console stating what the classification was based on. This is a great use of messages. However, when a different classification was specified using cc_args this message was no longer printed. This could be standardized as I think the messaging is nice, and especially important when the user is changing it from some default.

eribul commented 4 years ago

Review: You are right that the message is only displayed if relying on the default settings. This was inspired by the join-functions from the dplyr package, as described for the by argument for in the manual: If NULL, the default, *_join() will perform a natural join, using all variables in common across x and y. A message lists the variables so that you can check they're correct; suppress the message by supplying by explicitly.. This design pattern is also described and recommended in chap 15 of the Tidyverse design manual (https://design.tidyverse.org/def-inform.html). I like this approach since I think the message is less needed if the user explicitly specified the settings. I have nevertheless borrowed the text above for the manual to be more transparant considering theunderlying motif for this behaviour.