some more tips for R package creation guideline #17
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add information in coding style, other requirement in BiocConductor check list, minor tips for documentation
README.md
Outdated
|
|
||
| 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 |
There was a problem hiding this comment.
typo: agreement
Although note that Jeff would not say something like this. There is no universal agreement to use <- although I personally do.
There was a problem hiding this comment.
thanks! it is true. It was I got from BioConductor as feedback. Maybe should go to that section.
|
Hi @lpantano. I made a couple of comments on your suggested changes. I think that you should avoid mentioning |
|
Thanks @lcolladotor, I adapt the text according to your comments. Please, @jtleek if you think is useful, merge it whenever you want. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.