From edd at debian.org  Tue Jun  2 17:05:23 2015
From: edd at debian.org (Dirk Eddelbuettel)
Date: Tue, 2 Jun 2015 10:05:23 -0500
Subject: [Rd] NEWS.md support on CRAN
In-Reply-To: <21868.18877.410651.592015@fangorn.hornik.net>
References: <4819669E-8260-47B0-96BF-DC2B29E6BE21@me.com>
	<555FD2FE.8050600@gmail.com>
	<21856.13500.513608.759602@fangorn.hornik.net>
	<B98D36A9-901A-4413-88C0-22D7E923612E@me.com>
	<581D2C19-ED47-4D1D-8FC7-C4B4F368E637@gmail.com>
	<21868.18877.410651.592015@fangorn.hornik.net>
Message-ID: <21869.50739.349239.728644@max.nulle.part>


Hi Kurt,

On 1 June 2015 at 14:02, Kurt Hornik wrote:
| >>>>> peter dalgaard writes:
| 
| >> On 30 May 2015, at 01:20 , Imanuel Costigan <i.costigan at me.com> wrote:
| >> 
| >> So I assume this commit means NEWS.md is now no longer on blacklist? 
| >> 
| 
| > ....in the development version. Not true of released versions.
| 
| Now also in r-patched.

Nice.

Now, is there a way for package authors to preview how a .md would be
rendered?  I wrote mine with GitHub in mind, and they render fine. I looked a
recently-uploaded README.md of mine on CRAN, and it got some of the pandoc-y
parts wrong --- and looks unprofessional.

I would like to avoid that.  How can I?

Dirk

 
| -k
| 
| > -pd
| 
| 
| >> https://github.com/wch/r-source/commit/9ffe87264a1cd59a31a829f72d57af0f1bfa327a
| >> 
| >> Sent from my iPad
| >> 
| >> On 23 May 2015, at 6:05 pm, Kurt Hornik <Kurt.Hornik at wu.ac.at> wrote:
| >> 
| >>>>>>>> Duncan Murdoch writes:
| >>> 
| >>>>> On 22/05/2015 8:49 PM, Imanuel Costigan wrote:
| >>>>> Are there any plans for CRAN to support NEWS files in markdown? Bit of a hassle to go the the package?s Github (or other like) site to read NEWS.
| >>> 
| >>>> Not as far as I know.  There have been discussions about increasing the
| >>>> support of Markdown, but so far the conclusion has been that it's too
| >>>> hard to do -- the support is not stable enough on all the platforms
| >>>> where R runs.
| >>> 
| >>> There are actually two issues here.
| >>> 
| >>> For CRAN, we could in principle take inst/NEWS.md files, convert these
| >>> to HTML using pandoc, and use the HTML for the package web page.  (Would
| >>> need the CRAN incoming checks to be taught about inst/NEWS.md.)
| >>> 
| >>> However, we cannot use such files for utils::news() because we do not
| >>> (yet?) know how to reliably parse such files and extract the news items
| >>> (and hence cannot really compute on the news information).
| >>> 
| >>> Btw, currently only one package on CRAN has inst/NEWS.md (another one
| >>> has NEWS.md at top level).
| >>> 
| >>> Best
| >>> -k
| >>> 
| >>>> Markdown is allowed for vignettes (because the package author processes
| >>>> those), so I'd suggest putting your news into a vignette instead of a
| >>>> news file.  Put in a token news file that points to the vignette so
| >>>> users can find it.
| >>> 
| >>>> Duncan Murdoch
| >>> 
| >>>> ______________________________________________
| >>>> R-devel at r-project.org mailing list
| >>>> https://stat.ethz.ch/mailman/listinfo/r-devel
| >> 
| >> [[alternative HTML version deleted]]
| >> 
| >> ______________________________________________
| >> R-devel at r-project.org mailing list
| >> https://stat.ethz.ch/mailman/listinfo/r-devel
| 
| > -- 
| > Peter Dalgaard, Professor,
| > Center for Statistics, Copenhagen Business School
| > Solbjerg Plads 3, 2000 Frederiksberg, Denmark
| > Phone: (+45)38153501
| > Email: pd.mes at cbs.dk  Priv: PDalgd at gmail.com
| 
| > ______________________________________________
| > R-devel at r-project.org mailing list
| > https://stat.ethz.ch/mailman/listinfo/r-devel
| 
| ______________________________________________
| R-devel at r-project.org mailing list
| https://stat.ethz.ch/mailman/listinfo/r-devel

-- 
http://dirk.eddelbuettel.com | @eddelbuettel | edd at debian.org



[Rd] NEWS.md support on CRAN
Dirk Eddelbuettel