[R] On Reproducible Code
Rui Barradas
ruipbarradas at sapo.pt
Wed Jul 25 19:12:51 CEST 2012
Hello,
This does not mean that the posting guide is useless. Nor that it
couldn't or shouldn't be changed.
I would say "shouldn't" because there's a clear call to reproducible
code in another part of R, the man files created by package.skeleton:
\examples{
##---- Should be DIRECTLY executable !! ----
##-- ==> Define data, use random,
##-- or do help(data=index) for the standard data sets.
So maybe some of the posting guide should be more clear and concise.
Simple rules at the beginning, itemized or enumerated.
(And keep that end line.)
Rui Barradas
Em 25-07-2012 17:44, Gabor Grothendieck escreveu:
> On Wed, Jul 25, 2012 at 12:25 PM, Bert Gunter <gunter.berton at gene.com> wrote:
>> ********************
>> PLEASE provide commented, minimal, self-contained, reproducible code.
>> Whenever possible, provide a small example that can be easily loaded
>> and run to illustrate your problem. The R function dput() should
>> generally be used to do this.
>>
>> For a more complete discussion of how to post queries that will yield
>> accurate, helpful responses, refer to the posting guide at
>> http://www.R-project.org/posting-guide.html.
>> *********************
>>
>> I agree. Perhaps slightly modifying the message and moving it to the
>> top as I have done here (please feel free to edit as appropriate)
>> would be useful. This might have the psychological advantage of making
>> it painfuly obvious to OP's and readers when they have not followed
>> the recommendations.
>>
> The one line summary at the end is better than the posting guide. It
> tells you right off what to do in just one line.
>
> On the other hand realistically few are going to wade through the
> posting guide.. Its better to keep the one line summary at the end
> since that is the best bet that someone will actually read some
> guidance on how to post.
>
More information about the R-help
mailing list