[x] Please do not start the description with "Functions for", "This package", package name, title or similar.
[x] Please always explain all acronyms in the description text. e.g.: CDISC
If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form
authors (year)
authors (year)
authors (year, ISBN:...)
or if those are not available:
with no space after 'doi:', 'arXiv:', 'https:' and angle brackets for auto-linking.
(If you want to add a title as well please put it in quotes: "Title")
[x] Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar)
Missing Rd-tags:
write_dataset_json.Rd: \value
[x] You write information messages to the console that cannot be easily suppressed. It is more R like to generate objects that can be used to extract the information a user is interested in, and then print() that object. Instead of print()/cat() rather use message()/warning() or if(verbose)cat(..) (or maybe stop()) if you really have to write text to the console.
(except for print, summary, interactive functions)
e.g.: R/validate_dataset_json.R
mstackhouse
commented
11 months ago
[x] Please do not start the description with "Functions for", "This package", package name, title or similar.
[x] Please always explain all acronyms in the description text. e.g.: CDISC If there are references describing the methods in your package, please add these in the description field of your DESCRIPTION file in the form authors (year)
authors (year)
authors (year, ISBN:...)
or if those are not available:
[x] Please add \value to .Rd files regarding exported methods and explain the functions results in the documentation. Please write about the structure of the output (class) and also what the output means. (If a function does not return a value, please document that too, e.g. \value{No return value, called for side effects} or similar) Missing Rd-tags: write_dataset_json.Rd: \value
[x] You write information messages to the console that cannot be easily suppressed. It is more R like to generate objects that can be used to extract the information a user is interested in, and then print() that object. Instead of print()/cat() rather use message()/warning() or if(verbose)cat(..) (or maybe stop()) if you really have to write text to the console. (except for print, summary, interactive functions) e.g.: R/validate_dataset_json.R