Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Kurt Hornik
> Duncan Murdoch writes:

> On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:
>> Hi Kurt,
>> 
>> On 1 June 2015 at 14:02, Kurt Hornik wrote:
>> | > peter dalgaard writes:
>> |
>> | >> On 30 May 2015, at 01:20 , Imanuel Costigan  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?

> In the short term, you should probably try to run pandoc with the same 
> version and options as CRAN.  Kurt, can you say what these are?  If you 
> (Dirk) know pandoc options that emulate Github, it would probably make 
> sense for CRAN to use those.

Sure.  We currently have

pandoc 1.12.4.2
Compiled with texmath 0.6.6.1, highlighting-kate 0.5.8.5.

which we use with --email-obfuscation=references.

Best
-k

> In the longer term, the plan is to include our own parser and renderer.  
> At that point this would be easy.

> Duncan Murdoch
>> 
>> 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  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@r-project.org mailing list
>> |  https://stat.ethz.ch/mailman/listinfo/r-devel
>> | >>
>> | >> [[alternative HTML version deleted]]
>> | >>
>> | >> __
>> | >> R-devel@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@cbs.dk  Priv: pda...@gmail.com
>> |
>> | > __
>> | > R-devel@r-project.org mailing list
>> | > https://stat.ethz.ch/mailman/listinfo/r-devel
>> |
>> | __
>> | R-devel@r-project.org mailing list
>> | https://stat.ethz.ch/mailman/listinfo/r-devel
>> 

> __
> R-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Gabriel Becker
On Tue, Jun 2, 2015 at 12:40 PM, Jeroen Ooms  wrote:

> On Tue, Jun 2, 2015 at 8:42 PM, Duncan Murdoch 
> wrote:
> > Several of us have been talking about this, and have more or less
> decided against pandoc for the within-R version.  It is too hard to build,
> or to include with R, on weird platforms. Something like commonmark is more
> likely. We'd also like to separate the parse and render steps.
>
> The commonmark::markdown_xml function gives the parse tree in xml
> format. From there we could use something like xpath to query the
> content for individual news items and such. I think this is a more
> practical way of exposing the syntax tree than deeply nested lists or
> an external pointer to the internal C handle.
>

I don't think it should matter what the internal representation is here. So
long as there is proper tooling (query methods, [ and [[, names, etc)
around whatever class is returned, the user won't ever even know.

XPath is certainly a good way to implement those things, but I don't know
if we'd want it to be the actual abstraction users/developers use to
interact with the tree. Thinking about the right way to consume ASTs
represented by R objects (and how those objects should be
structured/implemented) could have applications well beyond markdown as
well, some of which may not have a canonical/direct XML representation.

~G



>
> __
> R-devel@r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>



-- 
Gabriel Becker, PhD
Computational Biologist
Bioinformatics and Computational Biology
Genentech, Inc.

[[alternative HTML version deleted]]

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Duncan Murdoch
On 02/06/2015 3:40 PM, Jeroen Ooms wrote:
> On Tue, Jun 2, 2015 at 8:42 PM, Duncan Murdoch  
> wrote:
>> Several of us have been talking about this, and have more or less decided 
>> against pandoc for the within-R version.  It is too hard to build, or to 
>> include with R, on weird platforms. Something like commonmark is more 
>> likely. We'd also like to separate the parse and render steps.
> 
> The commonmark::markdown_xml function gives the parse tree in xml
> format. From there we could use something like xpath to query the
> content for individual news items and such. I think this is a more
> practical way of exposing the syntax tree than deeply nested lists or
> an external pointer to the internal C handle.
> 

I'd rather avoid adding a dependence on the XML package; it's not a base
or recommended package, so most people don't have it.  Base R doesn't
have any XML processing built in.

One nice thing about the commonmark library is that it is
self-contained, so we can add it to R without pulling in a lot of other
stuff.  Using it to translate Markdown to XML loses that.

Duncan Murdoch

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Jeroen Ooms
On Tue, Jun 2, 2015 at 8:42 PM, Duncan Murdoch  wrote:
> Several of us have been talking about this, and have more or less decided 
> against pandoc for the within-R version.  It is too hard to build, or to 
> include with R, on weird platforms. Something like commonmark is more likely. 
> We'd also like to separate the parse and render steps.

The commonmark::markdown_xml function gives the parse tree in xml
format. From there we could use something like xpath to query the
content for individual news items and such. I think this is a more
practical way of exposing the syntax tree than deeply nested lists or
an external pointer to the internal C handle.

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Duncan Murdoch

On 02/06/2015 11:42 AM, Dirk Eddelbuettel wrote:

On 2 June 2015 at 11:25, Duncan Murdoch wrote:
| On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:
| > Hi Kurt,
| >
| > On 1 June 2015 at 14:02, Kurt Hornik wrote:
| > | > peter dalgaard writes:
| > |
| > | >> On 30 May 2015, at 01:20 , Imanuel Costigan  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?
|
| In the short term, you should probably try to run pandoc with the same
| version and options as CRAN.  Kurt, can you say what these are?  If you
| (Dirk) know pandoc options that emulate Github, it would probably make
| sense for CRAN to use those.
|
| In the longer term, the plan is to include our own parser and renderer.
| At that point this would be easy.

Thumbs up -- the 'rmarkdown' package by JJ et al basically already does just
this, and I have now authored a few (beamer) presentations that way.  And
quite like it.  It is all fully scriptable -- and of course available
interactive in whatever R shell you prefer -- and only requires pandoc
besides what is on CRAN.   Maybe medium-term Jeroen's commonmark can replace
pandoc and then we'd fully based on CRAN packages.


Several of us have been talking about this, and have more or less 
decided against pandoc for the within-R version.  It is too hard to 
build, or to include with R, on weird platforms.   Something like 
commonmark is more likely.  We'd also like to separate the parse and 
render steps.


Duncan Murdoch

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Kasper Daniel Hansen
This is supported by the NEWS.Rd mechanism, but many authors don't use it.
I agree; it would be wonderful if everyone used it and I think the main
(potential) advantage of this thread is to make it used (both by developers
and users) more broadly.

Kasper

On Tue, Jun 2, 2015 at 11:42 AM, Michael Dewey 
wrote:

> I realise this is not directly related to the topic but if changes are
> afoot would it be possible to make the use of any sort of news or changelog
> more prominent in the documentation? I maintain one of the CRAN task views
> and when someone updates his/her package it is much, much easier for me to
> see what has happened and if I need to update the text if they supply a
> news or changelog.
>
>
> On 02/06/2015 16:25, Duncan Murdoch wrote:
>
>> On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:
>>
>>> Hi Kurt,
>>>
>>> On 1 June 2015 at 14:02, Kurt Hornik wrote:
>>> | > peter dalgaard writes:
>>> |
>>> | >> On 30 May 2015, at 01:20 , Imanuel Costigan 
>>> 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?
>>>
>>
>> In the short term, you should probably try to run pandoc with the same
>> version and options as CRAN.  Kurt, can you say what these are?  If you
>> (Dirk) know pandoc options that emulate Github, it would probably make
>> sense for CRAN to use those.
>>
>> In the longer term, the plan is to include our own parser and renderer.
>> At that point this would be easy.
>>
>> Duncan Murdoch
>>
>>>
>>> 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 
>>> 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@r-project.org mailing list
>>> |  https://stat.ethz.ch/mailman/listinfo/r-devel
>>> | >>
>>> | >> [[alternative HTML version deleted]]
>>> | >>
>>> | >> __
>>> | >> R-devel@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@cbs.dk  Priv: pda...@gmail.com
>>> |
>>> | > __
>>> | > R-devel@r-project.org mailing list
>>> | > https://stat.ethz.ch/mailman/listinfo/r-devel
>>> |
>>> | __
>>> | R-devel@r-project.org mailing list
>>> | https://stat.ethz.ch/mailman/listinfo/r-devel
>>>
>>>
>> __
>> R-devel@r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-devel
>>
>
> --
> Michael
> http://www.dewey.myzen.co.uk/home.

Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Dirk Eddelbuettel

On 2 June 2015 at 11:25, Duncan Murdoch wrote:
| On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:
| > Hi Kurt,
| >
| > On 1 June 2015 at 14:02, Kurt Hornik wrote:
| > | > peter dalgaard writes:
| > |
| > | >> On 30 May 2015, at 01:20 , Imanuel Costigan  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?
| 
| In the short term, you should probably try to run pandoc with the same 
| version and options as CRAN.  Kurt, can you say what these are?  If you 
| (Dirk) know pandoc options that emulate Github, it would probably make 
| sense for CRAN to use those.
| 
| In the longer term, the plan is to include our own parser and renderer.  
| At that point this would be easy.

Thumbs up -- the 'rmarkdown' package by JJ et al basically already does just
this, and I have now authored a few (beamer) presentations that way.  And
quite like it.  It is all fully scriptable -- and of course available
interactive in whatever R shell you prefer -- and only requires pandoc
besides what is on CRAN.   Maybe medium-term Jeroen's commonmark can replace
pandoc and then we'd fully based on CRAN packages.

Dirk


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

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Michael Dewey
I realise this is not directly related to the topic but if changes are 
afoot would it be possible to make the use of any sort of news or 
changelog more prominent in the documentation? I maintain one of the 
CRAN task views and when someone updates his/her package it is much, 
much easier for me to see what has happened and if I need to update the 
text if they supply a news or changelog.


On 02/06/2015 16:25, Duncan Murdoch wrote:

On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:

Hi Kurt,

On 1 June 2015 at 14:02, Kurt Hornik wrote:
| > peter dalgaard writes:
|
| >> On 30 May 2015, at 01:20 , Imanuel Costigan 
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?


In the short term, you should probably try to run pandoc with the same
version and options as CRAN.  Kurt, can you say what these are?  If you
(Dirk) know pandoc options that emulate Github, it would probably make
sense for CRAN to use those.

In the longer term, the plan is to include our own parser and renderer.
At that point this would be easy.

Duncan Murdoch


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 
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@r-project.org mailing list
|  https://stat.ethz.ch/mailman/listinfo/r-devel
| >>
| >> [[alternative HTML version deleted]]
| >>
| >> __
| >> R-devel@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@cbs.dk  Priv: pda...@gmail.com
|
| > __
| > R-devel@r-project.org mailing list
| > https://stat.ethz.ch/mailman/listinfo/r-devel
|
| __
| R-devel@r-project.org mailing list
| https://stat.ethz.ch/mailman/listinfo/r-devel



__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


--
Michael
http://www.dewey.myzen.co.uk/home.html

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Duncan Murdoch

On 02/06/2015 11:05 AM, Dirk Eddelbuettel wrote:

Hi Kurt,

On 1 June 2015 at 14:02, Kurt Hornik wrote:
| > peter dalgaard writes:
|
| >> On 30 May 2015, at 01:20 , Imanuel Costigan  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?


In the short term, you should probably try to run pandoc with the same 
version and options as CRAN.  Kurt, can you say what these are?  If you 
(Dirk) know pandoc options that emulate Github, it would probably make 
sense for CRAN to use those.


In the longer term, the plan is to include our own parser and renderer.  
At that point this would be easy.


Duncan Murdoch


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  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@r-project.org mailing list
|  https://stat.ethz.ch/mailman/listinfo/r-devel
| >>
| >> [[alternative HTML version deleted]]
| >>
| >> __
| >> R-devel@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@cbs.dk  Priv: pda...@gmail.com
|
| > __
| > R-devel@r-project.org mailing list
| > https://stat.ethz.ch/mailman/listinfo/r-devel
|
| __
| R-devel@r-project.org mailing list
| https://stat.ethz.ch/mailman/listinfo/r-devel



__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel


Re: [Rd] NEWS.md support on CRAN

2015-06-02 Thread Dirk Eddelbuettel

Hi Kurt,

On 1 June 2015 at 14:02, Kurt Hornik wrote:
| > peter dalgaard writes:
| 
| >> On 30 May 2015, at 01:20 , Imanuel Costigan  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  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@r-project.org mailing list
|  https://stat.ethz.ch/mailman/listinfo/r-devel
| >> 
| >> [[alternative HTML version deleted]]
| >> 
| >> __
| >> R-devel@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@cbs.dk  Priv: pda...@gmail.com
| 
| > __
| > R-devel@r-project.org mailing list
| > https://stat.ethz.ch/mailman/listinfo/r-devel
| 
| __
| R-devel@r-project.org mailing list
| https://stat.ethz.ch/mailman/listinfo/r-devel

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

__
R-devel@r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel