Skip to content

Commit 5f43ab6

Browse files
authored
Merge pull request #92 from bburns632/feature/passCran
Changes to Remain in CRAN Compliance
2 parents 274813a + 4e2fba7 commit 5f43ab6

File tree

10 files changed

+5611
-295
lines changed

10 files changed

+5611
-295
lines changed

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: pkgnet
22
Type: Package
33
Title: Get Network Representation of an R Package
4-
Version: 0.1.0.9000
4+
Version: 0.2.0.9000
55
Authors@R: c(
66
person("Brian", "Burns", email = "brian.burns@uptake.com", role = c("aut", "cre")),
77
person("James", "Lamb", email = "james.lamb@uptake.com", role = c("aut")),
@@ -25,7 +25,7 @@ Imports:
2525
methods,
2626
mvbutils,
2727
R6,
28-
rmarkdown,
28+
rmarkdown(>= 1.9),
2929
tools,
3030
visNetwork
3131
Suggests:

NAMESPACE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ importFrom(mvbutils,foodweb)
4646
importFrom(rmarkdown,render)
4747
importFrom(tools,file_path_as_absolute)
4848
importFrom(tools,package_dependencies)
49+
importFrom(utils,browseURL)
4950
importFrom(utils,installed.packages)
5051
importFrom(utils,lsf.str)
5152
importFrom(visNetwork,visEdges)

R/CreatePackageReport.R

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@
1212
#' report will be produced in working directory.
1313
#' @importFrom assertthat assert_that is.string
1414
#' @importFrom methods is
15+
#' @importFrom utils browseURL
1516
#' @return A list of instantiated pkg_reporters fitted to \code{pkg_name}
1617
#' @export
1718
CreatePackageReport <- function(pkg_name
1819
, pkg_reporters = DefaultReporters()
1920
, pkg_path = NULL
20-
, report_path = file.path(getwd(), paste0(pkg_name, "_report.html"))
21+
, report_path = tempfile(pattern = pkg_name, fileext = ".html")
2122
) {
2223
# Input checks
2324
assertthat::assert_that(
@@ -51,6 +52,8 @@ CreatePackageReport <- function(pkg_name
5152
, pkg_name = pkg_name
5253
)
5354

55+
utils::browseURL(report_path)
56+
5457
return(invisible(builtReporters))
5558
}
5659

inst/package_report/header.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- This is HTML code for the header at the top of the page -->
2+
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
3+
<a class="navbar-brand" href="http://uptakeopensource.github.io/pkgnet">pkgnet</a>
4+
</nav>

inst/package_report/package_dependency_reporter.Rmd

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: "Package Dependency Report"
3-
output: html_document
4-
---
51

62
## Dependency Network
73

inst/package_report/package_report.Rmd

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,22 @@
11
---
2-
name: "pkgnet"
2+
title: "`r params$pkg_name`"
33
output:
44
html_document:
55
self_contained: TRUE
66
theme: flatly
77
include:
8+
in_header: header.html
89
after_body: footer.html
910
params:
1011
reporters: params$reporters
1112
pkg_name: params$pkg_name
1213
---
1314

14-
<!-- This is HTML code for the header at the top of the page -->
15-
<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
16-
<a class="navbar-brand" href="http://uptakeopensource.github.io/pkgnet">pkgnet</a>
17-
</nav>
18-
1915
```{r setup, include=FALSE}
2016
knitr::opts_chunk$set(echo = FALSE)
2117
pkgnet:::silence_logger()
2218
```
2319

24-
```{r title, results="asis"}
25-
cat(sprintf("# %s", pkg_name))
26-
```
27-
2820
```{r}
2921
reportTabs <- lapply(params$reporters, function(reporter) {
3022
report_env <- list2env(list(reporter = reporter))
@@ -33,6 +25,7 @@ reportTabs <- lapply(params$reporters, function(reporter) {
3325
, envir = report_env
3426
)
3527
})
28+
3629
```
3730

3831
```{r results="asis"}

inst/package_report/package_summary_reporter.Rmd

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
---
2-
title: "Package Summary Report"
3-
output: html_document
4-
---
51

62
## Package Summary
73

man/CreatePackageReport.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)