R/show-method.R

In classyfireR: R Interface to the 'ClassyFire' REST API

#' show-ClassyFire
#' @rdname show
#' @param object a `ClassyFire` S4 object
#' @return NULL
#' @importFrom methods show
#' @export

setMethod('show', signature = 'ClassyFire',
          function(object) {
            cat(cli::rule(
              left = crayon::bold('ClassyFire Object'),
              right = paste0('classyfireR v', utils::packageVersion('classyfireR'))
            ), '\n')

            cat(crayon::red(
              'Object Size:',
              format(utils::object.size(object), units = 'Kb'),
              '\n',
              '\n'
            ))

            cat(crayon::green('Info:'), '\n')

            cat('\t', cli::cat_bullet(object@meta$inchikey), '\n')
            cat('\t', cli::cat_bullet(object@meta$smiles), '\n')
            cat('\t', cli::cat_bullet(paste0(
              'Classification Version: ', object@meta$version
            )), '\n')



            if (nrow(object@classification) > 0) {
              TreeList <- list()
              for (i in seq_along(object@classification$Level)) {
                if (i == length(object@classification$Level)) {
                  TreeList[[i]] <- c(character(0))
                } else{
                  TreeList[[i]] <- object@classification$Level[(i + 1)]
                }
              }


              TreeDF <- data.frame(
                stringsAsFactors = FALSE,
                id = object@classification$Level,
                connections = I(TreeList)
              )

              TreeDF$label <-
                paste0(
                  crayon::bold(TreeDF$id),
                  ' : ',
                  cli::col_cyan(object@classification$Classification)
                )

              print(cli::tree(TreeDF))
            }

          })


#' show-Query
#' @rdname show
#' @param object a `Query` S4 object
#' @importFrom methods show
#' @export

setMethod('show', signature = 'Query',
          function(object) {
            cat(cli::rule(
              left = crayon::bold('ClassyFire Query Object'),
              right = paste0('classyfireR v', utils::packageVersion('classyfireR'))
            ), '\n')

            cat(crayon::red(
              'Object Size:',
              format(utils::object.size(object), units = 'Kb'),
              '\n',
              '\n'
            ))

            cat(crayon::green(paste0(
              nrow(object@meta), ' structures classified'
            )), '\n')

            for (i in seq_along(object@meta$identifier)) {
              cat(cli::cat_bullet(
                paste0(object@meta$identifier[i], ' : ',
                       object@meta$inchikey[i])
              ))
            }

            cat('\n')

            if (length(object@unclassified) > 0) {
              cat(crayon::yellow(paste0(
                length(object@unclassified), ' structures not classified'
              )), '\n')

              for (i in seq_along(object@unclassified)) {
                cat(cli::cat_bullet(paste0(
                  names(object@unclassified)[i], ' : ',
                  object@unclassified[i]
                )))
              }

            }

          })