.github/ISSUE_TEMPLATE/performance.md

In ropensci/gittargets: Data Version Control for the Targets Package

name: Performance about: "Runtime, memory, or storage inefficiency" title: "" labels: "topic: performance" assignees: wlandau

Prework

• [ ] Read and agree to the Contributor Code of Conduct and contributing guidelines.
• [ ] If there is already a relevant issue, whether open or closed, comment on the existing thread instead of posting a new issue.
• [ ] Post a minimal reproducible example like this one so the maintainer can troubleshoot the problems you identify. A reproducible example is:
  • [ ] Runnable: post enough R code and data so any onlooker can create the error on their own computer.
  • [ ] Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
  • [ ] Readable: format your code according to the tidyverse style guide.

Description

Please describe the performance issue.

Reproducible example

• [ ] Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
  • [ ] Runnable: post enough R code and data so any onlooker can create the error on their own computer.
  • [ ] Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
  • [ ] Readable: format your code according to the tidyverse style guide.

Benchmarks

How poorly does gittargets perform? To find out, we recommend you use the proffer package and take screenshots of the results displayed in your browser.

library(gittargets)
library(proffer)
px <- pprof({
  # All your gittargets code goes here.
})

ropensci/gittargets documentation built on July 21, 2024, 4:41 p.m.