R/get-osf-version.R

In tiernanmartin/NeighborhoodChangeTypology: Project: Neighborhood Change Typology for King County, WA

#' @title Get OSF File Version Number
#' @description Get the version number of a file that is stored in a OSF project.
#' @return a double
#' @param id Character, OSF id (osf.io/XXXX) for the node (project or component)
#'   to get the file info for
#' @param filename Character, the extact name of the specifc file
#' @importFrom osfr get_files_info
#' @export
get_osf_version <- function(id = NULL, filename = NULL){


  files_info <- osfr:::get_files_info(id, private = FALSE)

  if(!filename %in% files_info$name){stop(glue::glue("The string passed to the `filename` argument ({filename}) doesn't match any of the file names in this OSF folder.\nVisit the OSF folder and double-check the file name of the file you are trying to update."))}

  version <- files_info[files_info$name %in% filename,"version"][[1]]

  return(version)
}