Hi there!
I and a few others have been working on an R package we'd like to get on
CRAN. The package itself checks R dependencies to see if they have a known
CWE or CVE attached to them, and is intended to help R developers get a
better understanding on the quality of the dependencies they use!
A
README.md is a github convention... do not try to treat it like part of the R
package documentation. Instead, list it in your .Rbuildignore file and use it
to inform developers how to change the package and to direct (potential) users
browsing the GitHub repo to read the more conventional R docu
Good to know!
Right now we are using the README.rmd file to create the README.md, I
imagine we'd create something akin to oysteR.rmd to create the vignette?
The documentation on publishing to CRAN is great, but it's hard to tell
what a best practice is in this area. Also are vignettes strongly sug
Vignettes are not mandatory.
On 2020-03-07 6:05 p.m., Jeffry Hesse wrote:
> Good to know!
>
> Right now we are using the README.rmd file to create the README.md, I
> imagine we'd create something akin to oysteR.rmd to create the vignette?
> The documentation on publishing to CRAN is great, bu
My opinion is that vignettes make or break the uptake of a package... but they
are not mandatory.
I like to have a 'dev' directory where I keep meta-files like README.Rmd... of
course that gets listed in .Rbuildignore also.
I don't know about oysteR.Rmd. There are approved ways to have vignette
Umm, but README.md becomes README.html on CRAN, and it is very nice to have.
I'm not sure what the error you are seeing is, but having README on CRAN is
nice.
Have you .Rbuildignore 'd README.Rmd?? That should be ignored if I remember
correctly.
-Robert
On Sat, Mar 7, 2020, 5:55 PM Jeff Newmill
Apparently I am behind the times... both README (plain text) and README.md
(markdown) are now recognized files by R. But the Rmd file does need to be
ignored.
On March 7, 2020 4:09:03 PM PST, "Robert M. Flight" wrote:
>Umm, but README.md becomes README.html on CRAN, and it is very nice to
>have
Right now:
https://github.com/sonatype-nexus-community/oysteR/blob/master/.Rbuildignore#L2-L4
I have README.md, README.Rmd, and README.html ignored.
The CRAN documentation basically says if you have a WARNING or NOTE, etc...
get rid of it, and I kept running in to that error when I had README.md
