Skip to content

Commit

Permalink
extend debugging vignette with copy-paste code chunks
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Oct 17, 2023
1 parent 599a370 commit e8f75e8
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: roreviewapi
Title: Plumber API to report package structure and function
Version: 0.1.0.008
Version: 0.1.0.009
Authors@R:
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-2172-5265"))
Expand Down
2 changes: 1 addition & 1 deletion codemeta.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"codeRepository": "https://github.com/ropensci-review-tools/roreviewapi",
"issueTracker": "https://github.com/ropensci-review-tools/roreviewapi/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.1.0.008",
"version": "0.1.0.009",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down
22 changes: 22 additions & 0 deletions vignettes/debugging.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,25 @@ function](https://github.com/ropensci-review-tools/roreviewapi/blob/main/R/edito
`out <- roreviewapi::post_to_issue (out, orgrepo, issue_num)`. Alternative
values for `orgrepo` and `issue_num` can be used to first confirm that the
checks look okay before posting them to `ropensci/software-review`.

These steps can be run in two code chunks, the first directly in the shell
environment of the Digital Ocean droplet:

```{bash, eval = FALSE}
docker run -it --rm roreviewapi /bin/bash
R
```

And the second within the R environment:

```{r, eval = FALSE}
repourl <- "https://github.com/org/repo" # replace with actual org/repo values
path <- roreviewapi::dl_gh_repo (repourl)
os <- "ubuntu"
os_release <- "20.04"
p <- roreviewapi::pkgrep_install_deps (path, os, os_release)
checks <- pkgcheck::pkgcheck(path)
out <- roreviewapi::collate_editor_check (checks)
orgrepo <- "ropensci/software-review" # or somewhere else for testing purposes
out <- roreviewapi::post_to_issue (out, orgrepo, issue_num)
```

0 comments on commit e8f75e8

Please sign in to comment.