urdoch
>
>>
>> -Thomas
>>
>> Thomas J. Leeper
>> http://www.thomasleeper.com
>>
>>
>> On Fri, Jun 5, 2015 at 12:00 PM, wrote:
>> > Date: Thu, 04 Jun 2015 12:39:34 -0400
>> > From: Duncan Murdoch
>> > To: Mark
Mark,
As NEWS is not (yet) a required file for an R package on CRAN, we might do
well to encourage developers to provide that information. If moving with
the times means that more R package authors do that then I'll all for
allowing markdown. Many package authors do include markdown material
becau
Fri, Jun 5, 2015 at 12:00 PM, wrote:
> Date: Thu, 04 Jun 2015 12:39:34 -0400
> From: Duncan Murdoch
> To: Mark van der Loo , kurt.hor...@wu.ac.at
> Cc: R Devel Mailing List , Dirk Eddelbuettel
> , Imanuel Costigan
> Subject: Re: [Rd] NEWS.md support on CRAN
@Gavin: My aim was to point out that the ability to mix developer-facing
documentation with user-facing documentation is not a good reason to want
to support md.
I agree with Duncan that links to within a package would be useful (not
sure if NEWS.Rd supports this).
I'm not so convinced that packa
On 4 June 2015 at 11:16, Duncan Murdoch wrote:
> On 04/06/2015 1:09 PM, Prof Brian Ripley wrote:
>
>> On 04/06/2015 17:00, Gavin Simpson wrote:
>> ...
>> > 1. Markdown was designed to be as readable as possible in plain text
>> format
>> > (i.e. the sources, not the rendered file). There's nothin
Agreed, and "There's nothing stopping you reading and parsing a NEWS.md in
your head trivially." was very poorly phrased on my part. Just because I
can filter this out doesn't mean it is easy for others to do so.
Clearly anything with markup, even as light as markdown can be, is not as
simple as p
On 04/06/2015 1:09 PM, Prof Brian Ripley wrote:
On 04/06/2015 17:00, Gavin Simpson wrote:
...
> 1. Markdown was designed to be as readable as possible in plain text format
> (i.e. the sources, not the rendered file). There's nothing stopping you
> reading and parsing a NEWS.md in your head trivia
On 04/06/2015 17:00, Gavin Simpson wrote:
...
1. Markdown was designed to be as readable as possible in plain text format
(i.e. the sources, not the rendered file). There's nothing stopping you
reading and parsing a NEWS.md in your head trivially.
...
That claim is made frequently, but it is no
On 04/06/2015 11:05 AM, Mark van der Loo wrote:
FWIW (and a bit late in the discussion, I know), I for one do not care
about having NEWS in md format at all.
The solution the Yihui uses (linking to GH from NEWS.Rd) is really annoying
for people with no direct Internet access. For example, I work
Mark,
You're conflating issues here andTwo things I think you are missing:
1. Markdown was designed to be as readable as possible in plain text format
(i.e. the sources, not the rendered file). There's nothing stopping you
reading and parsing a NEWS.md in your head trivially.
2. The proposal her
Mark,
With respect I think you're conflating two different things here.
I completely agree with you that the workflow Yihui uses where the NEWS
file doesn't actually have the NEWS in it in a form that R can understand
is quite bad for users. It also makes the NEWS difficult to compute on,
which h
FWIW (and a bit late in the discussion, I know), I for one do not care
about having NEWS in md format at all.
The solution the Yihui uses (linking to GH from NEWS.Rd) is really annoying
for people with no direct Internet access. For example, I work at an
institute that handles a lot of private dat
> 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
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 platfo
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. Som
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 als
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
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 D
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 thi
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 t
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 dev
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 versio
> 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.
-k
> -pd
>> https://github.com/wch/r-so
> 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.
-pd
> https://github.com/wch/r-source/commit/9ffe87264a1cd59a31a829f72d57af0f1bfa327a
>
> Sent fr
So I assume this commit means NEWS.md is now no longer on blacklist?
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 wr
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.
In answer to your original question: plans are now being formed. It
seems as though full support s
On Sun, May 24, 2015 at 4:01 AM, Duncan Murdoch
wrote:
> The "markdown" package does some of what R would need to make use of Sundown,
> but not all: we really do need an R object representation of the parse tree,
> for functions like news() to work with in the short term, and the help system
I like the idea of supporting a small, strict subset of Markdown that
can be used to translate from NEWS.md to NEWS.
Following from Yihui's example, it would be pretty easy to write a
parser in R for such a format (and I'd be willing to try implementing
one, if that would be of interest).
Kevin
That is more or less what I had been doing for a long time (having
both NEWS.md and NEWS), but decided not to do it any more last year.
In fact, you can easily convert NEWS.md to a NEWS file that R's news()
can understand, e.g.
https://github.com/yihui/knitr/blob/947ad5fc94/Makefile#L8-L10 (if
your
On 24/05/2015 7:20 AM, Duncan Murdoch wrote:
> On 23/05/2015 10:26 PM, Imanuel Costigan wrote:
>>
>>> On 24 May 2015, at 12:07 pm, Duncan Murdoch
>>> wrote:
>>>
>>> On 23/05/2015 9:15 PM, Imanuel Costigan wrote:
While a parsed HTML version of the NEWS.md file would be nice, I would
lik
On 23/05/2015 10:26 PM, Imanuel Costigan wrote:
>
>> On 24 May 2015, at 12:07 pm, Duncan Murdoch wrote:
>>
>> On 23/05/2015 9:15 PM, Imanuel Costigan wrote:
>>> While a parsed HTML version of the NEWS.md file would be nice, I would like
>>> something much simpler: being able to "see” this file i
On 24 May 2015 at 14:01, Duncan Murdoch wrote:
> It sounds as though there are at least two possibilities for parsers
> that could be included in R: Sundown and commonmark.
>
Sundown is in fact deprecated,
https://github.com/vmg/sundown/commit/37728fb2d7137ff7c37d0a474cb827a8d6d846d8
in favor o
John MacFarlane, the author of Pandoc, has been working on a project (
http://commonmark.org/) to define a standard reference for Markdown*. There
are already two reference implementations, one in javascript, the other in
C: https://github.com/jgm/cmark
Regards,
baptiste
* There was some initia
> On 24 May 2015, at 12:07 pm, Duncan Murdoch wrote:
>
> On 23/05/2015 9:15 PM, Imanuel Costigan wrote:
>> While a parsed HTML version of the NEWS.md file would be nice, I would like
>> something much simpler: being able to "see” this file in the Help pane in
>> RStudio
>
> That isn't really
I’d suggest going with CommonMark if this will be the basis of broader support
for Markdown as it is well defined whereas GruberMarkdown is defined by broad
conventions with specifics determined by parsers.
> On 24 May 2015, at 12:01 pm, Duncan Murdoch wrote:
>
> On 23/05/2015 8:51 PM, Baptis
On 23/05/2015 9:15 PM, Imanuel Costigan wrote:
> While a parsed HTML version of the NEWS.md file would be nice, I would like
> something much simpler: being able to "see” this file in the Help pane in
> RStudio
That isn't really any simpler. RStudio is just displaying HTML whenever
it shows yo
On 23/05/2015 8:51 PM, Baptiste Auguie wrote:
> John MacFarlane, the author of Pandoc, has been working on a project
> (http://commonmark.org/) to define a standard reference for Markdown*.
> There are already two reference implementations, one in javascript, the
> other in C: https://github.com/j
While a parsed HTML version of the NEWS.md file would be nice, I would like
something much simpler: being able to "see” this file in the Help pane in
RStudio or being about to run something like show_news(“packagename”). Duncan
mentioned issues with the news() function being able to process meta
On Sat, May 23, 2015 at 8:00 PM, Duncan Murdoch
wrote:
[...]
> I wouldn't want R builds to depend on GitHub, so this sounds more
> interesting. I took a look at that website, and it looks problematic to
> me: the parser appears to be written in Javascript, and the install
> instructions (using
On 23/05/2015 9:25 AM, Gábor Csárdi wrote:
> On Sat, May 23, 2015 at 8:14 AM, Duncan Murdoch
> mailto:murdoch.dun...@gmail.com>> wrote:
> [...]
>
> I think the harder problem is display. CRAN can run pandoc, but can
> users who install the package from source? I would expect some obscure
On 23/05/2015 11:31 AM, Yihui Xie wrote:
> I agree. It is not worth all the trouble just to save the "bit of
> hassle to go to the package's Github site".
I'm sorry, but in my opinion this is not negotiable. R needs to run on
systems without Internet connections. It's not just a "bit of hassle"
On Sat, May 23, 2015 at 11:31 AM, Yihui Xie wrote:
> I agree. It is not worth all the trouble just to save the "bit of
> hassle to go to the package's Github site". In fact, the release notes
> on Github are more meaningful than a plain text NEWS.md or even a
> converted NEWS.html from Pandoc, e.
I agree. It is not worth all the trouble just to save the "bit of
hassle to go to the package's Github site". In fact, the release notes
on Github are more meaningful than a plain text NEWS.md or even a
converted NEWS.html from Pandoc, e.g. you can include bug report
numbers and attribute to users
On Sat, May 23, 2015 at 8:14 AM, Duncan Murdoch
wrote:
[...]
> I think the harder problem is display. CRAN can run pandoc, but can
> users who install the package from source? I would expect some obscure
> platforms (like Windows ;-) would not have it available.
>
[...]
I don't think pandoc is
On 23/05/2015 13:14, Duncan Murdoch wrote:
On 23/05/2015 4:05 AM, 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 r
On 23 May 2015 at 08:14, Duncan Murdoch wrote:
| I think the harder problem is display. CRAN can run pandoc, but can
| users who install the package from source? I would expect some obscure
| platforms (like Windows ;-) would not have it available. I could add it
| to Rtools on Windows, but I t
On 23/05/2015 4:05 AM, 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
> 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 increas
What I do is to use inst/NEWS.Rd as a placeholder that points to the
NEWS.md on Github, e.g.
http://cran.rstudio.com/web/packages/knitr/index.html
Regards,
Yihui
--
Yihui Xie
Web: http://yihui.name
On Fri, May 22, 2015 at 8:08 PM, Duncan Murdoch
wrote:
> On 22/05/2015 8:49 PM, Imanuel Costigan
What about treating it as a plain text file (i.e. no need for CRAN to support
parsing)?
> On 23 May 2015, at 11:08 am, Duncan Murdoch wrote:
>
> 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 pa
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
51 matches
Mail list logo
