R/add_bibtex.R

In JiaxiangBU/add2bibtex: Add to 'BibTex'

globalVariables(c(".", "text"))

#' Bibtex and Biblatex Template
#'
#' This function helps users to add Add a bib(La)tex template. It is pasted on the clipboard.
#'
#' @param type Character, by default \code{"more"}
#' @param is_paste Logical, by default \code{TRUE}
#' @return Character.
#' @author Jiaxiang Li
#'
#' @importFrom clipr write_clip
#' @importFrom glue glue
#' @import stringr
#' @importFrom xfun read_utf8
#' @import rvest
#' @import xml2
#' @export
#' @examples
#' add_bibtex("online", is_paste = FALSE)
#' add_bibtex("book", is_paste = FALSE)
#' add_bibtex("manual", is_paste = FALSE)
#' add_bibtex("more")
add_bibtex <- function(type = 'more', is_paste = TRUE) {

  if (type == 'more') {
    return(
      cat("More types are under development, please click\n\n
          https://jiaxiangli.netlify.com/2018/03/10/bibtex/")
    )
  }

  current_date <- Sys.Date()
  if (type == 'online') {
    text <- glue::glue(
      "
@online{Li2019,
  author = {Jiaxiang Li},
  title = {add2bibtex: Add bib(La)tex},
  year = 2019,
  howpublished = {add2bibtex},
  url = {https://github.com/JiaxiangBU/add2bibtex},
  urldate = {<current_date>}
}
        "
  , .open = "<"
  , .close = ">"
    )
  }

if (type == 'book') {
  text <- glue::glue(
    "
@book{Li2019,
  author    = {Jiaxiang Li},
  title     = {add2bibtex: Add bib(La)tex},
  publisher = {add2bibtex},
  year      = 2019,
  volume    = 1,
  series    = 1,
  address   = {Shanghai},
  edition   = 1,
  month     = 1,
  note      = {An optional note},
  isbn      = {111111111}
}
        "
, .open = "<"
, .close = ">"
  )
}

if (type == 'manual') {
  text <- glue::glue(
    "
@manual{Li2019,
  title = {add2bibtex: Add bib(La)tex},
  subtitle = {Easily Adding Bibliographies and Citations},
  author = {Jiaxiang Li},
  year = {2019},
  url = {https://github.com/JiaxiangBU/add2bibtex}
}
        "
, .open = "<"
, .close = ">"
  )
}

clip_and_print(text, is_paste = is_paste)
}


#' Add BibTex for a Kaggle URL.
#' @param url URL.
#' @param is_paste Logical, by default \code{TRUE}
#' @return Character.
#' @export
#' @examples
#' add_kaggle("https://www.kaggle.com/lijiaxiang/stacking", is_paste = FALSE)
add_kaggle <- function(url = '', is_paste = TRUE) {
  if (!stringr::str_detect(url, 'kaggle')) {
    stop("It is not a kaggle url.")
  }
  text <- xfun::read_utf8(url) %>% stringr::str_flatten("\n")

  author <-
    text %>% stringr::str_match('"displayName":"([A-z\\s]+)"') %>% .[2]

  title <-
    text %>% stringr::str_match('<title>([A-z\\s|:]+)</title>') %>% .[2]

  year <-
    text %>% stringr::str_match('"updatedTime":"([\\d]{4})') %>% .[2]

  howpublished <- "Kaggle"

  urldate <- Sys.Date()

  first_name <- stringr::str_replace_all(author, '\\s', '_')
  alias <- stringr::str_c(first_name, year)

  output <- glue::glue(
    "@online{<<alias>>,
        author = {<<author>>},
        title = {<<title>>},
        year = <<year>>,
        howpublished = {<<howpublished>>},
        url = {<<url>>},
        urldate = {<<urldate>>}
  }"
    ,
    .open = "<<"
    ,
    .close = ">>"
  )

  clip_and_print(output, is_paste = is_paste)
}


#' Add BibTex for a DataCamp URL.
#' @param url URL.
#' @param is_paste Logical, by default \code{TRUE}
#' @return Character.
#' @export
#' @examples
#' add_datacamp("https://www.datacamp.com/courses/extreme-gradient-boosting-with-xgboost",
#' is_paste = FALSE)
add_datacamp <- function(url = '', is_paste = TRUE) {
  if (!stringr::str_detect(url, 'datacamp')) {
    stop("It is not a datacamp url.")
  }
  text <- xml2::read_html(url)

  author <- text %>%
    rvest::html_nodes('.course__instructor-name') %>%
    rvest::html_text()

  title <- text %>%
    rvest::html_nodes('.header-hero__title') %>%
    rvest::html_text()

  year <- Sys.Date() %>% str_sub(1, 4)

  howpublished <- "DataCamp"

  urldate <- Sys.Date()

  output <-
    glue_bibtex(
      url = url,
      year = year,
      howpublished = howpublished,
      author = author,
      title = title
    )

  clip_and_print(output, is_paste = is_paste)
}

#' Add BibTex for a Zhihu URL.
#' @import zeallot
#' @param input The Zhihu shared text.
#' @param is_paste Logical, by default \code{TRUE}
#' @return Character.
#' @export
#' @examples
#' \donttest{add_zhihu("url")}
add_zhihu <- function(input = "", is_paste = TRUE) {
    # library(zeallot)
    c(text, url) %<-% {
      input %>%
        str_split("\n") %>%
        .[[1]]
    }
    c(title, author, howpublished) %<-% {
      text %>%
        str_split(" - ") %>%
        .[[1]]
    }
    title <- title %>% str_squish()
    author <- author %>% str_squish() %>% str_remove("\u7684\u56de\u7b54")
    howpublished <- howpublished %>% str_squish()

    year <- Sys.Date() %>% str_sub(1, 4)

    urldate <- Sys.Date()

    output <-
      glue_bibtex(
        url = url,
        year = year,
        howpublished = howpublished,
        author = author,
        title = title
      )

    clip_and_print(output, is_paste = TRUE)
  }

glue_bibtex <-
  function(url, year, howpublished, author, title) {
    urldate <- Sys.Date()

    first_name <- stringr::str_replace_all(author, '[\\s\uff0c]', '_')
    alias <- stringr::str_c(first_name, year)

    glue::glue(
      "@online{<<alias>>,
      author = {<<author>>},
      title = {<<title>>},
      year = <<year>>,
      howpublished = {<<howpublished>>},
      url = {<<url>>},
      urldate = {<<urldate>>}
      }"
      ,
      .open = "<<"
      ,
      .close = ">>"
    )

  }