12 changed files with 297 additions and 16 deletions
@ -1,5 +1,11 @@ |
|||
# Generated by roxygen2: do not edit by hand |
|||
|
|||
export(hgd) |
|||
export(install_viewer) |
|||
importFrom(httpgd,httpgd) |
|||
importFrom(httr,GET) |
|||
importFrom(httr,progress) |
|||
importFrom(httr,write_disk) |
|||
importFrom(jsonlite,fromJSON) |
|||
importFrom(tools,R_user_dir) |
|||
importFrom(utils,unzip) |
|||
|
|||
@ -0,0 +1,48 @@ |
|||
#' Install the binary viewer for your platform |
|||
#' |
|||
#' @export |
|||
install_viewer <- function() { |
|||
|
|||
path.expand(normalizePath( |
|||
file.path(tools::R_user_dir(package = "grandview"), "app") |
|||
)) -> place |
|||
|
|||
dir.create(place, recursive = TRUE, showWarnings = FALSE) |
|||
|
|||
if (is_macos()) { |
|||
|
|||
httr::GET( |
|||
url = "https://github.com/hrbrmstr/grandview/releases/latest/download/GrandView.app.zip", |
|||
httr::write_disk(file.path(place, "GrandView.app.zip"), overwrite = TRUE), |
|||
httr::progress() |
|||
) |
|||
|
|||
unzip( |
|||
zipfile = file.path(place, "GrandView.app.zip"), |
|||
exdir = place, |
|||
overwrite = TRUE |
|||
) |
|||
|
|||
file.remove(file.path(place, "GrandView.app.zip")) |
|||
|
|||
Sys.chmod(file.path(place, "GrandView.app", "Contents", "MacOS", "GrandView"), "0755") |
|||
|
|||
message("You may have to right-click and 'open' the app to accept permissions.") |
|||
|
|||
system2("open", shQuote(place)) |
|||
|
|||
} else if (is_linux()) { |
|||
|
|||
httr::GET( |
|||
url = "https://github.com/hrbrmstr/grandview/releases/latest/download/grandview", |
|||
httr::write_disk(file.path(place, "grandview"), overwrite = TRUE), |
|||
httr::progress() |
|||
) |
|||
|
|||
Sys.chmod(file.path(place, "grandview"), "0755") |
|||
|
|||
} else { |
|||
message("Windows not supported yet.") |
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,22 @@ |
|||
.onAttach <- function(libname, pkgname) { |
|||
|
|||
if (interactive()) { |
|||
|
|||
if (!grandview_exists()) { |
|||
|
|||
packageStartupMessage( |
|||
paste0(strwrap(paste0(c( |
|||
"{grandview} requires a binary application that you ", |
|||
"must manually install because of some made up CRAN ", |
|||
"rules that other, more user-friendly (but user-insecure) ", |
|||
"environments like Python do not have to abide by. ", |
|||
"Please run `grandview::install_viewer()` to use this ", |
|||
"package." |
|||
), collaspe = "")), collapse = "\n") |
|||
) |
|||
|
|||
} |
|||
|
|||
} |
|||
|
|||
} |
|||
@ -0,0 +1,116 @@ |
|||
|
|||
[](https://www.repostatus.org/#active) |
|||
[](https://keybase.io/hrbrmstr) |
|||
 |
|||
[](https://travis-ci.org/hrbrmstr/grandview) |
|||
 |
|||
 |
|||
|
|||
# grandview |
|||
|
|||
Provides Dedicated, Platform-Specific Viewers for ‘httpgd’ Graphics |
|||
Devices |
|||
|
|||
## Description |
|||
|
|||
The ‘httpgd’ packages provides a super-fast, asynchronous graphics |
|||
device for R graphics via ‘svglite’ and ‘later’ packages. Tools are |
|||
provided to use dedicated, platform-specific graphics “browsers” for |
|||
‘httpgd’ graphics devices. |
|||
|
|||
This is an EXPERIMENTAL standalone viewer, written in Go, for the |
|||
super-cool {httpgd} package `remotes::install_github("nx10/httpgd")`. |
|||
|
|||
The Windows viewer is not built yet because I haven’t got round to it |
|||
because I detest Windows. |
|||
|
|||
The goal is to have a “Quartz”-like window (for folks familiar with that |
|||
on macOS) with full functionality. Right now, it’s just a basic viewer |
|||
(and ‘save’ doesn’t work for some reason that I’m trying to figure out.) |
|||
|
|||
If I were you, I wouldn’t waste time on this package as it’ll likely |
|||
just get Sherlocked w/o notice by RStudio at some point and baked into |
|||
their ecosystem. I made it mainly for myself as I also detest using the |
|||
“browser for research” as an application runner. |
|||
|
|||
I’m also just as likely to add an {httpgd} viewer functionality into |
|||
RSwitch since it already functions as an RStudio Server client and it |
|||
won’t take much to have it work with {httpgd} directly (or via this |
|||
package). |
|||
|
|||
If you don’t trust the pre-built viewers, `tools-raw` has what you need |
|||
to make your own. They go into `tools::R_user_dir(package = |
|||
"grandview"), "app")` and for the macOS one you’ll need to use your own |
|||
signing cert (you may need to right-click open my built one once due to |
|||
faux security theatre by Apple). |
|||
|
|||
Because I rely on `tools::R_user_dir()` this package requires R 4.0.0+. |
|||
That was a deliberate choice since the adoption rate for R 4.0.0+ is |
|||
likely low (so I have time to refine this package) and I’d rather rely |
|||
on it than {rappdirs}. |
|||
|
|||
## What’s Inside The Tin |
|||
|
|||
The following functions are implemented: |
|||
|
|||
- `hgd`: Initialize httpgd graphics device, start server, and launch |
|||
viewer. |
|||
- `install_viewer`: Install the binary viewer for your platform |
|||
|
|||
## Installation |
|||
|
|||
``` r |
|||
remotes::install_git("https://git.rud.is/hrbrmstr/grandview.git") |
|||
# or |
|||
remotes::install_git("https://git.sr.ht/~hrbrmstr/grandview") |
|||
# or |
|||
remotes::install_gitlab("hrbrmstr/grandview") |
|||
# or |
|||
remotes::install_bitbucket("hrbrmstr/grandview") |
|||
# or |
|||
remotes::install_github("hrbrmstr/grandview") |
|||
``` |
|||
|
|||
NOTE: To use the ‘remotes’ install options you will need to have the |
|||
[{remotes} package](https://github.com/r-lib/remotes) installed. |
|||
|
|||
## Usage |
|||
|
|||
``` r |
|||
library(grandview) |
|||
|
|||
# current version |
|||
packageVersion("grandview") |
|||
## [1] '0.1.0' |
|||
``` |
|||
|
|||
``` r |
|||
install_viewer() # you'll get prompts to do this |
|||
|
|||
hgd() # it accepts params which will get passed to the viewer |
|||
|
|||
# plot stuff |
|||
|
|||
dev.off() |
|||
``` |
|||
|
|||
## grandview Metrics |
|||
|
|||
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) | |
|||
| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: | |
|||
| R | 6 | 0.67 | 134 | 0.73 | 40 | 0.48 | 53 | 0.54 | |
|||
| Go | 1 | 0.11 | 23 | 0.13 | 15 | 0.18 | 5 | 0.05 | |
|||
| make | 1 | 0.11 | 15 | 0.08 | 3 | 0.04 | 1 | 0.01 | |
|||
| Rmd | 1 | 0.11 | 11 | 0.06 | 26 | 0.31 | 40 | 0.40 | |
|||
|
|||
## Code of Conduct |
|||
|
|||
Please note that this project is released with a Contributor Code of |
|||
Conduct. By participating in this project you agree to abide by its |
|||
terms. |
|||
@ -0,0 +1,11 @@ |
|||
% Generated by roxygen2: do not edit by hand |
|||
% Please edit documentation in R/install-viewer.R |
|||
\name{install_viewer} |
|||
\alias{install_viewer} |
|||
\title{Install the binary viewer for your platform} |
|||
\usage{ |
|||
install_viewer() |
|||
} |
|||
\description{ |
|||
Install the binary viewer for your platform |
|||
} |
|||
Loading…
Reference in new issue