54 | 
57 |
58 | Content not found. Please use links in the navbar.
59 |
60 | 
17 |
18 |
19 | [](https://lifecycle.r-lib.org/articles/stages.html#experimental)
20 | [](https://CRAN.R-project.org/package=hexsession)
21 |
22 |
23 | The goal of hexsession is to create a tile of hexagonal logos for packages installed on your machine. Tiles can be created for a set of packages specified with a character vector, or for the loaded packages in your session (all packages attached to the search path except for base packages).
24 |
25 | ## Installation
26 |
27 | You can install the development version of hexsession like so:
28 |
29 | ``` r
30 | # install.packages("remotes)
31 | remotes::install_github("luisdva/hexsession")
32 | ```
33 |
34 | ## Using hexsession
35 |
36 | With hexsession installed, we can create a self-contained HTML file with tiled hex logos for all loaded packages in a session. If a package does not have a logo bundled in `man/figures/` or if the image cannot be found easily, a generic-looking logo with the package name will be generated.
37 |
38 | * svg files are internally converted to png
39 | * If the images bundled with a package do not match 'hex' or 'logo', or there are multiple possible options, users are prompted to specify which file to use.
40 |
41 |
42 |
43 | For a given session with libraries loaded in addition to base packages:
44 |
45 | ```{r example, eval=FALSE}
46 | library(hexsession)
47 | make_tile()
48 |
49 | # custom set of packages
50 | make_tile(packages=c("terra","sf","tidyr"))
51 | ```
52 |
53 | The `make_tile()` function will render the HTML output in a new folder in the working directory using a Quarto template file that will also be copied to this new directory.
54 |
55 | For a session with the following packages loaded:
56 |
57 | ```{r, eval=FALSE}
58 | library(annotater)
59 | library(ggforce)
60 | library(purrr)
61 | library(forcats)
62 | library(unheadr)
63 | library(sdmTMB)
64 | library(parsnip)
65 | library(DBI)
66 | library(broom)
67 | library(vctrs)
68 | library(patchwork)
69 |
70 |
71 | hexsession::make_tile()
72 | ```
73 |
74 | The output would look like this:
75 | 
76 | _I don't know how to show the rendered interactive file on the GitHub readme, if anyone does please let me know 😅._
77 |
78 | Once downloaded to your machine and opened in a browser, the [hexout_example.html](inst/extdata/hexout_example.html) shows the interactive, responsive HTML version with cool hover effects that adapts to the size of the browser window and includes hyperlinks to each package website.
79 |
80 | To save a static version of the hex tile, we call `snap_tile()` with a path to the output image and optionally, height and width values to change the viewport size.
81 |
82 | The result:
83 |
84 | 
85 |
86 | ### Dark mode
87 |
88 | To draw the tiles on a dark background, set `dark_mode` to `TRUE` when creating or capturing your hex logos.
89 |
90 | ```{r, eval=FALSE}
91 | hexsession::make_tile(dark_mode = TRUE)
92 | hexsession::snap_tile("test.png",dark_mode = TRUE)
93 | ```
94 |
95 | ## User-provided images and urls
96 |
97 | `make_tile` can now take vectors of additional images and their respective but optional urls to include in the hex grid.
98 |
99 | ```{r, eval=FALSE}
100 | make_tile(packages = c("tidyterra", "sf"),
101 | local_images = c("path/to/your/image1.png",
102 | "path/to/your/image2.png",
103 | local_urls = c("https://an-example.web", "https://another-example.com"))
104 |
105 | ```
106 |
107 | ## Notes
108 |
109 | This packages depends on working installations of magick, Quarto, and chromote and thus needs a Chromium-based web browser (e.g., Chrome, Chromium, Opera, or Vivaldi) installation.
110 |
111 | hexsession is very much work in progress and highly experimental. I am still learning good-practices for packages that create files and directories, use system commands, and launch browser sessions.
112 |
113 | All feedback is welcome in any form (issues, pull requests, etc.)
114 |
115 | ### Credit and LLM disclosure statement
116 |
117 | - css and html code for the responsive hex grid comes from [this tutorial](https://css-tricks.com/hexagons-and-beyond-flexible-responsive-grid-patterns-sans-media-queries/) by Temani Afif.
118 |
119 | - the javascript code to populate the divs in the Quarto template was written with input from the Claude 3.5 Sonnet LLM running in the Continue extension in the Positron IDE.
120 |
121 |
122 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 | # hexsession
5 |
6 |
7 |
8 | [](https://lifecycle.r-lib.org/articles/stages.html#experimental)
10 | [](https://CRAN.R-project.org/package=hexsession)
12 |
13 |
14 | The goal of hexsession is to create a tile of hexagonal logos for
15 | packages installed on your machine. Tiles can be created for a set of
16 | packages specified with a character vector, or for the loaded packages
17 | in your session (all packages attached to the search path except for
18 | base packages).
19 |
20 | ## Installation
21 |
22 | You can install the development version of hexsession like so:
23 |
24 | ``` r
25 | # install.packages("remotes)
26 | remotes::install_github("luisdva/hexsession")
27 | ```
28 |
29 | ## Using hexsession
30 |
31 | With hexsession installed, we can create a self-contained HTML file with
32 | tiled hex logos for all loaded packages in a session. If a package does
33 | not have a logo bundled in `man/figures/` or if the image cannot be
34 | found easily, a generic-looking logo with the package name will be
35 | generated.
36 |
37 | - svg files are internally converted to png
38 | - If the images bundled with a package do not match ‘hex’ or ‘logo’, or
39 | there are multiple possible options, users are prompted to specify
40 | which file to use.
41 |
42 | For a given session with libraries loaded in addition to base packages:
43 |
44 | ``` r
45 | library(hexsession)
46 | make_tile()
47 |
48 | # custom set of packages
49 | make_tile(packages=c("terra","sf","tidyr"))
50 | ```
51 |
52 | The `make_tile()` function will render the HTML output in a new folder
53 | in the working directory using a Quarto template file that will also be
54 | copied to this new directory.
55 |
56 | For a session with the following packages loaded:
57 |
58 | ``` r
59 | library(annotater)
60 | library(ggforce)
61 | library(purrr)
62 | library(forcats)
63 | library(unheadr)
64 | library(sdmTMB)
65 | library(parsnip)
66 | library(DBI)
67 | library(broom)
68 | library(vctrs)
69 | library(patchwork)
70 |
71 |
72 | hexsession::make_tile()
73 | ```
74 |
75 | The output would look like this:  *I don’t
76 | know how to show the rendered interactive file on the GitHub readme, if
77 | anyone does please let me know 😅.*
78 |
79 | Once downloaded to your machine and opened in a browser, the
80 | [hexout_example.html](inst/extdata/hexout_example.html) shows the
81 | interactive, responsive HTML version with cool hover effects that adapts
82 | to the size of the browser window and includes hyperlinks to each
83 | package website.
84 |
85 | To save a static version of the hex tile, we call `snap_tile()` with a
86 | path to the output image and optionally, height and width values to
87 | change the viewport size.
88 |
89 | The result:
90 |
91 | 
92 |
93 | ### Dark mode
94 |
95 | To draw the tiles on a dark background, set `dark_mode` to `TRUE` when
96 | creating or capturing your hex logos.
97 |
98 | ``` r
99 | hexsession::make_tile(dark_mode = TRUE)
100 | hexsession::snap_tile("test.png",dark_mode = TRUE)
101 | ```
102 |
103 | ## User-provided images and urls
104 |
105 | `make_tile` can now take vectors of additional images and their
106 | respective but optional urls to include in the hex grid.
107 |
108 | ``` r
109 | make_tile(packages = c("tidyterra", "sf"),
110 | local_images = c("path/to/your/image1.png",
111 | "path/to/your/image2.png",
112 | local_urls = c("https://an-example.web", "https://another-example.com"))
113 |
114 | ```
115 |
116 | ## Notes
117 |
118 | This packages depends on working installations of magick, Quarto, and
119 | chromote and thus needs a Chromium-based web browser (e.g., Chrome,
120 | Chromium, Opera, or Vivaldi) installation.
121 |
122 | hexsession is very much work in progress and highly experimental. I am
123 | still learning good-practices for packages that create files and
124 | directories, use system commands, and launch browser sessions.
125 |
126 | All feedback is welcome in any form (issues, pull requests, etc.)
127 |
128 | ### Credit and LLM disclosure statement
129 |
130 | - css and html code for the responsive hex grid comes from [this
131 | tutorial](https://css-tricks.com/hexagons-and-beyond-flexible-responsive-grid-patterns-sans-media-queries/)
132 | by Temani Afif.
133 |
134 | - the javascript code to populate the divs in the Quarto template was
135 | written with input from the Claude 3.5 Sonnet LLM running in the
136 | Continue extension in the Positron IDE.
137 |
--------------------------------------------------------------------------------
/_pkgdown.yml:
--------------------------------------------------------------------------------
1 | url: https://luisdva.github.io/hexsession/
2 | template:
3 | bootstrap: 5
4 |
5 |
--------------------------------------------------------------------------------
/cran-comments.md:
--------------------------------------------------------------------------------
1 | ## R CMD check results
2 |
3 | 0 errors | 0 warnings | 1 note
4 |
5 | * This is a new release.
6 |
--------------------------------------------------------------------------------
/docs/404.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | 4 |
5 |
6 |
7 |
8 |