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

some more tips for R package creation guideline #17

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

lpantano
Copy link

Hi!

This is great. I am in the middle of a package submission for BiocConductor, and basically everything is here. I just added some more tips that I found useful and need to do to have my package in better conditions to be accepted in BiocConductor.

Feel free to reject/close. I just thought it could be useful for others.

PS: thanks for the practical machine learning course. Awesome.

Add information in coding style, 
other requirement in BiocConductor check list,
minor tips for documentation
1. Your indent should be 4 spaces on every line
2. Each line can be no more than 80 columns
3. Use `<-` for asignament. Even if R understands `=`, it is a community agrenment to use the other one
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: agreement

Although note that Jeff would not say something like this. There is no universal agreement to use <- although I personally do.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks! it is true. It was I got from BioConductor as feedback. Maybe should go to that section.

@lcolladotor
Copy link
Collaborator

Hi @lpantano. I made a couple of comments on your suggested changes. I think that you should avoid mentioning <- vs =. Otherwise, it looks good. Once you are done, ping jtleek (with @).

@lpantano
Copy link
Author

lpantano commented Apr 6, 2016

Thanks @lcolladotor, I adapt the text according to your comments. Please, @jtleek if you think is useful, merge it whenever you want.
Thanks for this great resource.

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

Successfully merging this pull request may close these issues.

2 participants