Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Functions #6

Closed
jospueyo opened this issue Mar 21, 2023 · 1 comment
Closed

Functions #6

jospueyo opened this issue Mar 21, 2023 · 1 comment

Comments

@jospueyo
Copy link
Collaborator

@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.

@jospueyo
Copy link
Collaborator Author

I made all suggested changes. They improved a lot the package. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant