Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Change to webshot2 #59

Closed
wants to merge 9 commits into from
Closed

Change to webshot2 #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
03e416e
Change to webshot2
LukasWallrich Dec 11, 2022
24f151a
Change to webshot2 and remove phantomjs check
LukasWallrich Dec 11, 2022
395aa13
Change to webshot2
LukasWallrich Dec 11, 2022
f4ec216
Update to webshot2
LukasWallrich Dec 11, 2022
88d363b
Fix typo
LukasWallrich Dec 11, 2022
8c0526e
Squash changes to webshot2
LukasWallrich Dec 11, 2022
96a5c2e
Merge branch 'main' of https://github.com/LukasWallrich/namedropR
LukasWallrich Dec 11, 2022
990e4cd
Remove no cite_key warning when single citation is processed
LukasWallrich Dec 11, 2022
7cf2526
Update rcrossref note after CRAN release of 1.2
LukasWallrich Dec 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ Imports:
R.utils,
readr,
stringr,
webshot
webshot2
Suggests:
knitr,
rcrossref,
rcrossref (>= 1.2),
rmarkdown,
testthat (>= 3.0.0),
withr
Expand Down
9 changes: 5 additions & 4 deletions R/drop_name.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@
#' In other words, either one, many or no BibTeX citation keys can be specified.
#' @param export_as A string specifying the desired output format. For now supports PNG and HTML.
#' Use "html" to include the 'bare' taglist (recommended for inclusion in Rmarkdown documents) or "html_full" to write a standalone .html file including <head> etc.
#' The PNG is a screenshot of the rendered HTML via the 'webshot' package. The filename represents this two step approach on purpose.
#' For webshot you need to install phantomJS once (see 'webshot' documentation).
#' The PNG is a screenshot of the rendered HTML via the 'webshot2' package. The filename represents this two step approach on purpose.
#' @param output_dir A string specifying the relative path, where the rendered output files should be stored.
#' @param max_authors Integer number of maximum authors to print. If the number of authors exceeds this, the list is cropped accordingly.
#' @param include_qr Character string specifying the way the QR code should be included or if no QR code should be included.
Expand Down Expand Up @@ -83,7 +82,7 @@
#' @import dplyr
#' @importFrom htmltools tags save_html
#' @importFrom lubridate year ymd
#' @importFrom webshot webshot
#' @importFrom webshot2 webshot
#' @importFrom stringr str_detect str_remove_all str_trunc str_replace_all

drop_name <- function(bib, cite_key,
Expand Down Expand Up @@ -293,7 +292,9 @@ drop_name <- function(bib, cite_key,
# handle different input options for bibtex keys
if (missing(cite_key)) {
n_bib <- nrow(clean_bib)
message(paste0("No cite_key specified. Working through all possible ", n_bib, " entries in the bibliography."))
if (n_bib > 1) {
message(paste0("No cite_key specified. Working through all possible ", n_bib, " entries in the bibliography."))
}
work_list <- clean_bib
} else if (!is.character(cite_key)) {
stop("cite_key must be of type 'caracter'.")
Expand Down
12 changes: 4 additions & 8 deletions R/write_vc.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
#' }
#'
#' @importFrom htmltools tags save_html
#' @importFrom webshot webshot
#' @importFrom webshot2 webshot

write_vc <- function(work_item, path_absolute, output_dir, export_as) {

Expand Down Expand Up @@ -73,10 +73,7 @@ write_vc <- function(work_item, path_absolute, output_dir, export_as) {
}
)
} else if (export_as == "png") {
if (!webshot::is_phantomjs_installed()) {
message("You need to download and install phantomJS to save output as PNG. Try running 'webshot::install_phantomjs()' once.")
} else {
# renders as "complete" html to get the white background for PNG snapshot.
# renders as "complete" html to get the white background for PNG snapshot.
tryCatch(
expr = {
htmltools::save_html(work_item$vcs, file = output_file)
Expand All @@ -91,10 +88,9 @@ write_vc <- function(work_item, path_absolute, output_dir, export_as) {
}
)


tryCatch(
expr = {
webshot::webshot(output_file, paste0(output_file, ".png"), selector = ".visual-citation", zoom = 2)
webshot2::webshot(output_file, paste0(output_file, ".png"), selector = ".visual-citation", zoom = 2)
},
error = function(e) {
message("Could not take a screenshot of the intermediate HTML.")
Expand All @@ -116,7 +112,7 @@ write_vc <- function(work_item, path_absolute, output_dir, export_as) {
R.utils::getRelativePath(png_out)
)
return(return_path_png)
}

} else {
stop("Output format unknown")
}
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ drop_name(
### Pulling data from Crossref
If you don't have a *.bib file, but DOIs instead, you can pass them to `drop_name_crossref()` which pulls the data from [Crossref](https://www.crossref.org) and passes the downloaded data on to `drop_name()`.

**TEMPORARY NOTE:** *Due to recent API changes in Crossref you need to have {rcrossref} version > 1.1 installed. As long as {rcrossref} v1.2 is not yet available on CRAN, installing the development version >= v1.1.0.99 might avoid error messages. If you don't feel comfortable with installing development versions (use at your own risk!), this function will only work with CRAN version of {rcrossref} >= v1.2 installed.*
**TEMPORARY NOTE:** *Due to recent API changes in Crossref you need to have {rcrossref} version >= 1.2 installed.*

``` r
# DOIs can be named vectors...
Expand Down
4 changes: 2 additions & 2 deletions tests/testthat/test-write_vc.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,8 @@ test_that("saving as html works as expected", {
# "Some 2023", "Alice; Bob; Charlie", "Journal of Unnecessary R Packages", "Alice2023", "2023", VCS
# )
#
# # writes a file, this test can only be run, if phantomJS is installed:
# if(webshot::is_phantomjs_installed()) {
# # writes a file, this test can only be run, if a chromium browser is installed
# if(!is.null(chromote::find_chrome())) {
# withr::with_dir(
# new = new,
# code = {
Expand Down