When discussing performance with colleagues, teaching, sending a bug report or searching for guidance on mailing lists and here on Stack Overflow, a reproducible example is often asked and always helpful.
What are your tips for creating an excellent example? How do you paste data structures from r in a text format? What other information should you include?
Are there other tricks in addition to using dput()
, dump()
or structure()
? When should you include library()
or require()
statements? Which reserved words should one avoid, in addition to c
, df
, data
, etc.?
How does one make a great r reproducible example?
I’m confused about the scope of the question. People seem to have jumped on the interpretation of reproducible example in asking questions on SO or R-help (how to “reproduce the error”). What about reproducible R examples in help pages? In package demos? In tutorials / presentations?