Now news(package = "princurve") works - by renaming CHANGELOG to NEWS

[HenrikBengtsson]

By renaming CHANGELOG to NEWS and placing it under the inst/ folder, R will recognize it and news(package = "princurve") will parse it and rendering it in text, as HTML, etc.

I haven't edited the content, but I've verified that it passes the (picky) parser that R uses for NEWS files. If the parser is not happy, news() will just display it as plain text. I use the following home-cooked validator for this:

check_news <- function (pathname = "NEWS") {
    news <- tools:::.news_reader_default(pathname)
    bad <- which(attr(news, "bad"))
    if (length(bad) == 0) 
        return(news)
    news_bad <- news[bad, ]
    msg <- sprintf("Detected %d malformed entries in %s: %s", 
        nrow(news_bad), sQuote(pathname), paste(news_bad$Version, 
            collapse = ", "))
    stop(msg, call. = FALSE)
}

[HenrikBengtsson]

Forgot to say: By using a proper NEWS file, it will also be linked to from the HTML help index of the package.

[codecov]

Codecov Report

Merging #11 into master will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##           master    #11   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           8      8           
  Lines         266    266           
=====================================
  Hits          266    266

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 49c2a4e...a9db5a6. Read the comment docs.

[rcannood]

Good to know, thanks!