From 1cebea0d2031a95ab993094fc6621fe5a6394cfa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Sun, 13 Sep 2026 09:01:31 +0000 Subject: [PATCH 1/2] docs: Adopt the shared README rendering configuration Part of harmonizing how `README.md` and the pkgdown front page are produced across the fleet. The output format becomes `cynkratemplate::readme_document`, which is a `github_document` that also writes the pkgdown front page from the same render. It carries `-smart` and `--wrap=preserve`, matching duckdb-r, which has used them longest: together they keep the pandoc pass close to an identity transform, so no smart quotes and no reflowing to 72 columns. That keeps the rendered file close to its source and makes future diffs sentence-level rather than whole-paragraph. Stating the format by name rather than repeating its settings means the settings live in one place instead of thirty. Rendering is unchanged in how it is invoked: `rmarkdown::render()`, `devtools::build_readme()` and the Knit button all work as before, and all now produce both files. The only new requirement is that cynkratemplate be installed. No prose changes. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m --- README.Rmd | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.Rmd b/README.Rmd index 3efd4e3..9ce3198 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,8 +1,11 @@ --- -output: downlit::readme_document +output: cynkratemplate::readme_document --- - + ```{r, setup, echo = FALSE, message = FALSE} @@ -50,6 +53,8 @@ library(igraphdata) data(package = "igraphdata") ``` +--- + # License CC BY-SA 4.0, plus see [LICENSE](LICENSE) for the licenses of the From 41314a6b786994dd667fe5716a234020d029813e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kirill=20M=C3=BCller?= Date: Sun, 13 Sep 2026 09:01:32 +0000 Subject: [PATCH 2/2] docs: Render README.md and index.md Output of `cynkratemplate::render_readme()`, with no hand edits. `README.md` changes are the pandoc settings from the previous commit taking effect: `--wrap=preserve` stops badge lines and sentences being broken at 72 columns, and `-smart` leaves quotes and dashes as written. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m --- .Rbuildignore | 1 + README.md | 65 ++++++++++++++++++++++++++++++--------------------- index.md | 50 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 90 insertions(+), 26 deletions(-) create mode 100644 index.md diff --git a/.Rbuildignore b/.Rbuildignore index 816b707..8e43941 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -7,3 +7,4 @@ ^\.github$ ^README\.Rmd$ ^\.ccache$ +^index\.md$ diff --git a/README.md b/README.md index cc5795b..f593f2e 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,56 @@ - + + # Data sets for the igraph R package -[![Linux build status](https://travis-ci.org/igraph/igraphdata.png)](https://travis-ci.org/igraph/igraphdata) [![Windows build status](https://ci.appveyor.com/api/projects/status/6wov9hh8oprrpkhs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/igraphdata) +[![Linux build status](https://travis-ci.org/igraph/igraphdata.png)](https://travis-ci.org/igraph/igraphdata) +[![Windows build status](https://ci.appveyor.com/api/projects/status/6wov9hh8oprrpkhs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/igraphdata) -This is a data R package, that contains network data sets, to be used with the igraph R package. +This is a data R package, that contains network data sets, +to be used with the igraph R package. ## Installation From CRAN: -
-install.packages("igraphdata")
+``` r +install.packages("igraphdata") +``` -You can install the development version from Github, using the [devtools package](https://github.com/hadley/devtools): +You can install the development version from Github, using the +[devtools package](https://github.com/hadley/devtools): -
-devtools::install_github("igraph/igraphdata")
+``` r +devtools::install_github("igraph/igraphdata") +``` ## Usage -
-library(igraphdata)
-data(package = "igraphdata")
-
-#> Data sets in package 'igraphdata':
-#> 
-#> Koenigsberg             Bridges of Koenigsberg from Euler's times
-#> UKfaculty               Friendship network of a UK university faculty
-#> USairports              US airport network, 2010 December
-#> enron                   Enron Email Network
-#> foodwebs                A collection of food webs
-#> immuno                  Immunoglobulin interaction network
-#> karate                  Zachary's karate club network
-#> kite                    Krackhardt's kite
-#> macaque                 Visuotactile brain areas and connections
-#> rfid                    Hospital encounter network data
-#> yeast                   Yeast protein interaction network
+``` r +library(igraphdata) +data(package = "igraphdata") +``` + + #> Data sets in package 'igraphdata': + #> + #> enron Enron Email Network + #> foodwebs A collection of food webs + #> immuno Immunoglobulin interaction network + #> karate Zachary's karate club network + #> kite Krackhardt's kite + #> Koenigsberg Bridges of Koenigsberg from Euler's times + #> macaque Visuotactile brain areas and connections + #> rfid Hospital encounter network data + #> UKfaculty Friendship network of a UK university faculty + #> USairports US airport network, 2010 December + #> yeast Yeast protein interaction network + +------------------------------------------------------------------------ # License -CC BY-SA 4.0, plus see [LICENSE](LICENSE) for the licenses of the individual data sets. +CC BY-SA 4.0, plus see [LICENSE](LICENSE) for the licenses of the +individual data sets. diff --git a/index.md b/index.md new file mode 100644 index 0000000..c35c4b6 --- /dev/null +++ b/index.md @@ -0,0 +1,50 @@ + + + + +# Data sets for the igraph R package + +[![Linux build status](https://travis-ci.org/igraph/igraphdata.png)](https://travis-ci.org/igraph/igraphdata) +[![Windows build status](https://ci.appveyor.com/api/projects/status/6wov9hh8oprrpkhs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/igraphdata) + +This is a data R package, that contains network data sets, +to be used with the igraph R package. + +## Installation + +From CRAN: + +``` r +install.packages("igraphdata") +``` + +You can install the development version from Github, using the +[devtools package](https://github.com/hadley/devtools): + +``` r +devtools::install_github("igraph/igraphdata") +``` + +## Usage + +``` r +library(igraphdata) +data(package = "igraphdata") +``` + + #> Data sets in package 'igraphdata': + #> + #> enron Enron Email Network + #> foodwebs A collection of food webs + #> immuno Immunoglobulin interaction network + #> karate Zachary's karate club network + #> kite Krackhardt's kite + #> Koenigsberg Bridges of Koenigsberg from Euler's times + #> macaque Visuotactile brain areas and connections + #> rfid Hospital encounter network data + #> UKfaculty Friendship network of a UK university faculty + #> USairports US airport network, 2010 December + #> yeast Yeast protein interaction network