[R-wiki] To allow modification or not

Philippe Grosjean phgrosjean at sciviews.org
Sat Feb 4 18:13:28 CET 2006


Damian Betebenner wrote:
> All,
> 
> Wouldn't it be good to allow modification/supplementation of the Examples in the .Rd files put on the Wiki.
> Perhaps this is what you mean by the "discussion section" at the end that will be editable. One place that
> some of the help files are currently weak on is the examples. Allowing users to add better examples to
> the help pages would be a great application of Wiki openess. 

Yes, it is what we mean: to be able to add something at the end of the 
Wiki version of the Rd files. Martin said that it would be also 
interesting to do so with the manuals (Introduction to R, Writing R 
extensions, ...).

Philippe

> Moreover, a number of these examples would also be relevant within the Snippets sections.
> 
> For example:
> 
> matrixcomp <- function(T,n){
>               if (n==1) return(T)
>               else return(matrixcom(T, n-1) %*% T)
> }
> 
> 1. Could be an example within the '%*%' help file.
> 2. Could be a simple example of recursion in R.
> 
> And being editable, would allow users to refine and improve the examples.
> 
> My $.02
> 
> Damian
>  
> 
>>>>May be am I a little bit behind here, but I don't think the idea is to 
>>>>put *everything* in the Wiki. We want to put only what can be modified 
>>>>by R users. The only exception, currently, is the 'R documentation', 
>>>>alias the .Rd files that will be read-only, but with a discussion 
>>>>section at the end that will be editable. The Wiki is a *complement* to 
>>>>other resources, not a *replacement*, isn't it?
>>>>
>>>>Otherwise, there is no technical barriers to put also the manuals (as 
>>>>read-only) on the Wiki. Same remark for package vignettes.
>>>>
>>>>Best,
>>>>
>>>>Philippe Grosjean
>>>>
>>>>_______________________________________________
>>>>R-sig-wiki mailing list
>>>>R-sig-wiki at r-project.org
>>>>https://stat.ethz.ch/mailman/listinfo/r-sig-wiki
> 
> 
> 
>



More information about the R-sig-wiki mailing list