R/build_ris.R

In nealhaddaway/GSscraper: Scrapes Citation Information From Google Scholar Results

#' Build RIS files from other sources
#'
#' @description Builds an RIS file based on a basic input of
#' fields corresponding to a minimum information for
#' de-duplication and record identification from external
#' API sources (e.g. CrossRef).
#' @param data A data frame object containing bibliographic
#' data. Each item is an independent line in the
#' data frame. The data frame must contain
#' columns named as follows: 'authors', 'year', 'titles',
#' 'source', 'volume', 'issue', 'start_page', 'end_page',
#' and 'dois'.
#' @param save Logical argument to specify whether the output
#' file should be saved as an .ris file.
#' @param filename Optional name of the output file if
#' save = TRUE. Default is 'export'.
#' @param path Path to which file should be saved.
#' @return An RIS formatted text file saved to the desired
#' path.
#' @export
#' @importFrom utils write.table
#' @examples
#' \dontrun{
#' data <- read.csv('inst/extdata/data.csv')
#' ris <- build_ris(data, save=TRUE)
#' }
build_ris <- function(data,
                      save = FALSE,
                      filename = 'export',
                      path = NULL){

  if (is.data.frame(data) == FALSE){
    stop('Please ensure the input object is a data frame')
  }

  #add missing columns where necessary (ensures build below works even if fields not present)
  if(is.null(data$source_type) == TRUE){data$source_type <- NA}
  if(is.null(data$authors) == TRUE){data$authors <- NA}
  if(is.null(data$year) == TRUE){data$year <- NA}
  if(is.null(data$titles) == TRUE){data$titles <- NA}
  if(is.null(data$journal) == TRUE){data$journal <- NA}
  if(is.null(data$volume) == TRUE){data$volume <- NA}
  if(is.null(data$issue) == TRUE){data$issue <- NA}
  if(is.null(data$start_page) == TRUE){data$start_page <- NA}
  if(is.null(data$end_page) == TRUE){data$end_page <- NA}
  if(is.null(data$descriptions) == TRUE){data$descriptions <- NA}
  if(is.null(data$dois) == TRUE){data$dois <- NA}
  if(is.null(data$publisher) == TRUE){data$publisher <- NA}
  if(is.null(data$links) == TRUE){data$links <- NA}
  if(is.null(data$notes) == TRUE){data$notes <- NA}
  if(is.null(data$M1) == TRUE){data$M1 <- NA}
  if(is.null(data$database) == TRUE){data$database <- NA}
  if(is.null(data$AN) == TRUE){data$AN <- NA}

  #replace NAs with ''
  data[is.na(data)==TRUE]=''

  #create RIS file
  ris <- paste(paste0('\n',
                      'TY  - ', data$source_type, '\n',
                      'AU  - ', data$authors, '\n',
                      'TI  - ', data$titles, '\n',
                      'PY  - ', data$year, '\n',
                      'AB  - ', data$descriptions, '\n',
                      'SP  - ', data$start_page, '\n',
                      'EP  - ', data$end_page, '\n',
                      'JF  - ', data$journal, '\n',
                      'VL  - ', data$volume, '\n',
                      'IS  - ', data$issue, '\n',
                      'DO  - ', data$dois, '\n',
                      'UR  - ', data$links, '\n',
                      'PB  - ', data$publisher, '\n',
                      'N1  - ', data$notes, '\n',
                      'M1  - ', data$M1, '\n',
                      'DB  - ', data$DB, '\n',
                      'AN  - ', data$AN, '\n',
                      'ER  - '),
               collapse = '\n')

  #generate report if file exported as .ris
  if (save == TRUE){
    utils::write.table(ris, file = paste0(path, filename, '.ris'), row.names = FALSE, col.names = FALSE)
    if (is.null(path) == TRUE){
      location <- 'your working directory'
    } else {
      location <- paste0(path)
    }
    report <- paste0('The output file "', filename, '.ris" has been saved to ', location)
    message(report)
  }

  return(ris)

}