R/updateCellContents.R

In ceparman/Core5.3: Core API fucntions

#' updateCellContents -  Updates amount and concentrations of cell content 
#'
#' \code{updateCellContents} Updates amount and concentrations of cell content 
#' @param coreApi coreApi object with valid jsessionid
#' @param containerType container entity type
#' @param containerBarcode container barcode
#' @param containerCellNum container cell number
#' @param sampleLotBarcode barcode of lot to add to cell
#' @param amount amount to add (numeric)
#' @param amountUnit units
#' @param concentration (numeric)
#' @param concentrationUnit concentration units
#' @param useVerbose use verbose communications for debugging
#' @export
#' @return RETURN returns a list $entity contains updated container
#'         information, $response contains the entire http response
#' @examples
#'\dontrun{
#' api<-CoreAPIV2("PATH TO JSON FILE")
#' login<- CoreAPIV2::authBasic(api)
#' cell<-
#' CoreAPIV2::logOut(login$coreApi )
#' }
#'@author Craig Parman ngsAnalytics, ngsanalytics.com
#'@description \code{updateCellContents} - Updates amount and concentrations of cell content Uses JSON API. 





updateCellContents <-
  function (coreApi,
            containerType,
            containerBarcode,
            containerCellNum,
            sampleLotBarcode,
            amount,
            amountUnit,
            concentration,
            concentrationUnit,
            useVerbose = FALSE)
    
  {
    sdkCmd <- jsonlite::unbox("update-cell")
    
    data <- list()
    
    
    data[["amount"]] <- jsonlite::unbox(amount)
    
    data[["amountUnit"]] <- jsonlite::unbox(amountUnit)
    
    data[["concentration"]] <- jsonlite::unbox(concentration)
    
    data[["concentrationUnit"]] <- jsonlite::unbox(concentrationUnit)
    
    
    
    
    data[["cellRefs"]] <-
      list(c(list(
        cellNum = jsonlite::unbox(containerCellNum),
        containerRef = list(barcode = jsonlite::unbox(containerBarcode))
      )))
    
    
    data[["lotRef"]] <-
      list(barcode = jsonlite::unbox(sampleLotBarcode))
    
    
    
    
    responseOptions <-
      c("CONTEXT_GET",
        "MESSAGE_LEVEL_WARN",
        "INCLUDE_CONTAINER_CELL_CONTENTS")
    logicOptions <- list()
    typeParam <- jsonlite::unbox(containerType)
    
    
    
    
    
    
    request <-
      list(
        request = list(
          sdkCmd = sdkCmd,
          data = data,
          typeParam = typeParam,
          responseOptions = responseOptions,
          logicOptions = logicOptions
        )
      )
    
    headers <- c(
      'Content-Type' = "application/json",
      Accept = "*/*",
      Cookie = paste0("AWSELB=", coreApi$awselb)
    )
    
    
    response <-
      CoreAPIV2::apiPOST(
        coreApi,
        resource = NULL,
        body = jsonlite::toJSON(request),
        encode = "raw",
        headers = headers,
        special = "json",
        useVerbose = useVerbose
      )
    
    
    
    
    list(entity = httr::content(response)$response$data,
         response = response)
    
  }