add text to network page for #59

Author: mpadge

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: repometrics
 Title: Metrics for Your Code Repository
-Version: 0.1.3.058
+Version: 0.1.3.059
 Authors@R: 
     person("Mark", "Padgham", , "mark.padgham@email.com", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0003-2172-5265"))

R/quarto-dashboard.R

@@ -202,6 +202,16 @@ quarto_insert_pkg_name <- function (dir, pkg_name) {
     i <- grep ("^(\\s+?)title", y)
     y [i] <- gsub ("Package", pkg_name, y [i])
     brio::write_lines (y, f_yaml)
+
+    f_network <- fs::path (dir, "network.qmd")
+    network_qmd <- brio::read_lines (f_network)
+    network_qmd <- gsub (
+        "the XXX repository",
+        paste0 ("the `", pkg_name, "` repository"),
+        network_qmd,
+        fixed = TRUE
+    )
+    brio::write_lines (network_qmd, f_network)
 }
 
 check_dashboard_arg <- function (data) {

codemeta.json

@@ -8,7 +8,7 @@
   "codeRepository": "https://github.com/ropensci-review-tools/repometrics",
   "issueTracker": "https://github.com/ropensci-review-tools/repometrics/issues",
   "license": "https://spdx.org/licenses/GPL-3.0",
-  "version": "0.1.3.058",
+  "version": "0.1.3.059",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",

inst/extdata/quarto/network.qmd

@@ -32,6 +32,19 @@ nodes_user <- data.frame (id = dat_pkg$rm$contribs_from_gh_api$login, group = 4L
 nodes_user$group [which (nodes_user$id %in% names (dat_users))] <- 3L
 ```
 
+This page shows an interactive network diagram of the main developers of
+the XXX repository, including all other repositories they have contributed to.
+Links are shown between developers and repositories, as well as between
+developers themselves. Thickness of lines connecting developers are scaled
+according to relative efforts in joint repositories.
+
+The "person" nodes show main developers of the XXX repository, which is shown
+in the centre of the graph as "this_repo". The lines connecting "this_repo"
+with developers are scaled according to proportional contributions to other
+repositories on which they have worked (over the default time-span of the
+previous year), with circles for those repositories scaled by total numbers of
+commits made by the core developer team of the XXX repository.
+
 ```{ojs import-network-data}
 network = FileAttachment("results-user-network.json").json()
 ```