internal/notes.md

In tidyverse/reprex: Prepare Reproducible Example Code via the Clipboard

Formatting principles

Notes and links re: best formatting for different venues.

Stack Overflow

• http://stackoverflow.com/editing-help
• specifics re: code highlighting

GitHub

• GitHub issues use GitHub-flavored markdown

gist.github.com

• In theory, this is the domain of gistr, but people also tend to post .R or .Rmd and NOT resulting .md ... is there a gap in tools or is this just an unfortunate behavior pattern? I don't always want to render these files to see what someone's trying to show me.

Notes to self

Lines where a .R file gets spun in render(): render.R#L129-L154

Other work

The "great R reproducible example" Stack Overflow thread referenced above has some discussion of practical details, such as this comment.

The "Code to import data from a Stack overflow query into R" stackoverflow thread. This is from the perspective of someone considering answering a question, in which the OP has not provided a proper reprex. Specifically: it addresses input data that is in suboptimal form.

A collection of R scripts by GitHub user rsaporta contains some functions related to Stack Overflow: so_functions.r. No license.

The GitHub package overflow. Appears to also emphasize the difficulty above, e.g., getting data out of Stack Overflow questions that don't follow reprex best practices. A bit hard to tell what's there, not much in README, no vignette. License is GPL-3.

tidyverse/reprex documentation built on Jan. 27, 2024, 5:55 p.m.