You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In the description, you should add a link to the CRedit and also improve the text. This is your main function, and most likely where users will spend more time. You should try to document it as much as possible.
read_template.R
Since this function is reading a template, you should add some test to check if the information in the file has the expected structure (column names, number of columns, ..). If not, issuing a warning might be a good policy, letting the user know that the expected format was not found.
write_cras.R
In line 34, I suggest you add an input option for the user to drop (or not) authors without contributions. I suspect that, in large research groups, might be best to also make it explicit that some people did not contribute.
The description of the function was not found. Since this is a tiny package, I suggest to add a nice and comprehensive description of the function.
The text was updated successfully, but these errors were encountered:
@msperlin
create_template.R
In the description, you should add a link to the CRedit and also improve the text. This is your main function, and most likely where users will spend more time. You should try to document it as much as possible.
read_template.R
Since this function is reading a template, you should add some test to check if the information in the file has the expected structure (column names, number of columns, ..). If not, issuing a warning might be a good policy, letting the user know that the expected format was not found.
write_cras.R
In line 34, I suggest you add an input option for the user to drop (or not) authors without contributions. I suspect that, in large research groups, might be best to also make it explicit that some people did not contribute.
The description of the function was not found. Since this is a tiny package, I suggest to add a nice and comprehensive description of the function.
The text was updated successfully, but these errors were encountered: