R/list_assets_in_session.R

In PLAY-behaviorome/databraryapi: Interact with the 'Databrary.org' API

#' Assets In Databrary Session.

#' @description
#' `r lifecycle::badge("superseded")`
#'
#' This function has been superseded by `list_session_assets()`.
#'
#' @param session_id Slot/session ID.
#' @param vb A Boolean value. If TRUE provides verbose output.
#' 
#' @returns A data frame with information about a selected session.
#'
#' @examples
#' \donttest{
#' list_assets_in_session() # Assets in session 9807 (from Volume 1)
#' #' }
#'
#' @export
list_assets_in_session <- function(session_id = 9807, vb = FALSE) {
  # Check parameters
  assertthat::assert_that(length(session_id) == 1)
  assertthat::assert_that(is.numeric(session_id))
  assertthat::assert_that(session_id >= 1)
  assertthat::assert_that(length(vb) == 1)
  assertthat::assert_that(is.logical(vb))
  
  if (vb)
    message('list_assets_in_session()...')
  
  # Make URL, GET(), and handle response ---------------------------
  
  r <-
    GET_db_contents(URL_components = paste0('/api/slot/', session_id,
                                            '/-?assets'),
                    vb = vb)
  if (!is.null(r)) {
    # if (vb) message("Making data frame from returned content.")
    if (is.data.frame(r$assets)) {
      df <- data.frame(r$assets)
      df <- dplyr::rename(df, asset_id = "id",
                          asset_type_id = "format")
      df <- format_to_filetypes(df, vb = vb)
    } else {
      df <- NULL
    }
    return(df)
  } else {
    if (vb)
      message('Download failed')
  }
  
}

#==================================================================
#' Lists assets in a given Databrary session (slot).
#'
#' @param session_id Slot/session ID.
#' @param media_type A string indicating what type of file.
#' @param vb A Boolean value. If TRUE provides verbose output.
#' @return A data frame with the assets in the selected volume and session.
list_specified_assets_in_session <- function(session_id = 9807,
                                             media_type = 'MPEG-4 video',
                                             vb = FALSE) {
  # List all assets
  if (vb)
    message('list_specified_assets_in_session()...')
  al <- list_assets_in_session(session_id, vb = vb)
  dplyr::filter(al, .data$asset_type == media_type)
}

#========================================================================================
format_to_filetypes <- function(vol_assets, vb = FALSE) {
  # Parameter checking -------------------------------------------------------------------
  if (is.null(vol_assets)) {
    stop("Must provide non-NULL data frame of volume assets")
  }
  if (!is.data.frame(vol_assets)) {
    stop("vol_assets must be a data frame.")
  }
  
  if (vb)
    message('format_to_filetypes()...')
  # Get file types -----------------------------------------------------------------------
  if (vb)
    message("Getting supported file types.")
  fts <- get_supported_file_types()
  if (is.null(fts)) {
    stop("List of supported file types not available.")
  }
  
  # Merge file types with assets in volume -----------------------------------------------
  if (vb)
    message("Matching file types to those in specified volume.")
  df <- dplyr::left_join(vol_assets, fts, by = c('asset_type_id'))
  df
}