Skip to content

Commit

Permalink
improve ghist_dashboard man entry
Browse files Browse the repository at this point in the history
  • Loading branch information
mpadge committed Jul 16, 2024
1 parent 76cec76 commit 6c41748
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 5 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: githist
Title: Code analyses traced along the 'git' history of a package
Version: 0.1.0.003
Version: 0.1.0.004
Authors@R:
person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-2172-5265"))
Expand Down
8 changes: 6 additions & 2 deletions R/quarto-dashboard.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,15 @@
#'
#' @param results Results of main \link{githist} function applied to one
#' package.
#' @return Nothing; quarto dashboard will automatically open on function call.
#' @param action One of "preview", to start and open a live preview of the
#' dashboard website, or "render" to render a static version without previewing
#' or opening.
#' @return (Invisibly) Path to main "index.html" document of quarto site. Note
#' that the site must be served with `action = "preview"`, and will not work by
#' simply opening this "index.html" file.
#' @export
ghist_dashboard <- function (results, action = "preview") {


check_dashboard_arg (results)

requireNamespace ("brio")
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/githist",
"issueTracker": "https://github.com/ropensci-review-tools/githist/issues",
"license": "https://spdx.org/licenses/GPL-3.0",
"version": "0.1.0.003",
"version": "0.1.0.004",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
Expand Down
8 changes: 7 additions & 1 deletion man/ghist_dashboard.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 6c41748

Please sign in to comment.