Examples of every option

[eribul]

I'd like to see examples that utilize every option available in each function, rather than only simple examples. I often find myself wanting to use a non-default option in a function and not finding any example that helps me understand how to specify the option. Having simple examples is essential, but also including a more complex example that utilizes more than just the basic function arguments will really help users with more complex problems or more advanced users. For example, the example given in the classcodes help file isn't very useful. The object you pass to as.classcodes() in the example is already a classcodes object. How would I use the argument hierarchy? I don't know because you haven't given an example.

[eribul]

All exports according to NAMESPACE

• [x] S3method("$<-",classcodes)
• [x] S3method("[",classcodes)
• [x] S3method("[<-",classcodes)
• [x] S3method(as.data.frame,classified)
• [x] S3method(as.data.table,classified)
• [x] S3method(as.keyvalue,classcodes)
• [x] S3method(categorize,codified)
• [x] S3method(categorize,data.frame)
• [x] S3method(categorize,data.table)
• [x] S3method(classify,data.frame)
• [x] S3method(classify,default)
• [x] S3method(filter_dates,Date)
• [x] S3method(filter_dates,data.frame)
• [x] S3method(index,data.frame)
• [x] S3method(index,matrix)
• [x] S3method(print,summary.classcodes)
• [x] S3method(summary,classcodes)
• [x] S3method(visualize,character)
• [x] S3method(visualize,classcodes)
• [x] export("%>%")
• [x] export(all_classcodes)
• [x] export(as.classcodes)
• [x] export(as.codedata)
• [x] export(categorize)
• [x] export(classify)
• [x] export(codebook)
• [x] export(codebooks)
• [x] export(codify)
• [x] export(dates_within)
• [x] export(filter_dates)
• [x] export(index)
• [x] export(is.classcodes)
• [x] export(is.codedata)
• [x] export(set_classcodes)
• [x] export(spss2date)
• [x] export(visualize)

[eribul]

covr::package_coverage(<path-to-your-package>, type = "examples")

[eribul]

Review: I agree and have added examples which I think should cover all arguments etc.