[R-pkg-devel] NOTEs - Problems with news in 'NEWS.md'
Henrik Bengtsson
henr|k@bengt@@on @end|ng |rom gm@||@com
Tue Dec 13 03:58:18 CET 2022
I've got a check_news() function to test that a NEWS.md can be parsed
as expected. See attached file (if that gets dropped in the
interwebs, it's also at
https://gist.github.com/HenrikBengtsson/2361371be4ae8681b3ee2eb361730990).
Call it in the folder where the NEWS.md file is.
My $.02
/Henrik
On Mon, Dec 12, 2022 at 5:46 PM Max Turgeon <Max.Turgeon using umanitoba.ca> wrote:
>
> Hi Sanjeev,
>
> Requirements change over time, and it's the responsibility of the maintainer to make sure the package keeps up with the new requirements. Things that "worked" back in 2010 may no longer fit these new requirements, and such is the case for the NEWS.md file.
>
> It's useful to look at examples from other packages to understand how your NEWS.md file should be formatted. Here's ggplot2's, but you can find many other examples on Github: https://raw.githubusercontent.com/tidyverse/ggplot2/main/NEWS.md
>
> I'll point out two things they do that is relevant (according to ?news):
>
> * Every new version of the package has a separate level-1 header (i.e. a line that starts with #). New changes appearing in that version are then listed below.
> * Changes are sometimes grouped in categories, where each category has a separate level-2 header (i.e. a line that starts with ##).
>
> In your case, you don't seem to use headers at all. If I were you, that's where I would start.
>
> Good luck!
>
>
> Max Turgeon<https://www.name-coach.com/maxime-turgeon>
>
> Adjunct Professor
>
> Department of Statistics
> University of Manitoba
>
> maxturgeon.ca<http://maxturgeon.ca/>
>
> ________________________________
> From: R-package-devel <r-package-devel-bounces using r-project.org> on behalf of Sanjeev Sariya <sanjeevsariya using gmail.com>
> Sent: Monday, December 12, 2022 7:21 PM
> To: Uwe Ligges <ligges using statistik.tu-dortmund.de>; r-package-devel using r-project.org <r-package-devel using r-project.org>
> Subject: Re: [R-pkg-devel] NOTEs - Problems with news in 'NEWS.md'
>
> ********************************************************
> Caution: This message was sent from outside the University of Manitoba.
> ********************************************************
>
> Dear Devel and Uwe,
>
> Sorry about not providing more details.
> Please see log file links below:
>
> https://win-builder.r-project.org/incoming_pretest/GARCOM_1.2.1_20221212_174734/Windows/00check.log
>
> https://win-builder.r-project.org/incoming_pretest/GARCOM_1.2.1_20221212_174734/Debian/00check.log
>
> I do not have access to the old email address.
>
> Attached is also the news.md file. I cannot understand what is needed in
> ?news. It was fine until ~2020 Dec.
>
> github link of package:
> https://github.com/sariya/GARCOM/tree/new_test_hello
> Best,
> --
> Sanjeev M
>
>
>
>
> On Tue, Dec 13, 2022 at 5:52 AM Uwe Ligges <ligges using statistik.tu-dortmund.de>
> wrote:
>
> >
> >
> > On 12.12.2022 18:05, Sanjeev Sariya wrote:
> > > Hi there,
> > >
> > > I made changes to the CRAN package by adding a file to the inst/ext
> > folder.
> > > I mention about this in the NEWS.md file however, when I upload the build
> > > package .gz file to cran it fails to pass with error message as:
> > >
> > >
> > > * Problems with news in 'NEWS.md': No news entries found.*
> > >
> > > There are two notes. I cannot seem to find the second note.
> >
> > For other to help, you really have to say where the package is and where
> > the check log is. As a CRAN team member, I know:
> >
> > 1. Note is about the maintainer address change. Once the package passes
> > the checks, an auto generated message will go to the old maintainer
> > address. But for that to happen, the second note has to be fixed:
> >
> > 2. Problems with news in 'NEWS.md':
> > No news entries found.
> >
> > See ?news which explains how NEWS.md files should be written.
> >
> > Best,
> > Uwe Ligges
> >
> >
> >
> > >
> > > Kindly help.
> > > --
> > > Sanjeev M
> > >
> > > [[alternative HTML version deleted]]
> > >
> > > ______________________________________________
> > > R-package-devel using r-project.org mailing list
> > > https://stat.ethz.ch/mailman/listinfo/r-package-devel
> >
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>
>
> [[alternative HTML version deleted]]
>
> ______________________________________________
> R-package-devel using r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-package-devel
More information about the R-package-devel
mailing list