R/bt_get_detective_characteristics.R

In global-trade-alert/gtabastiat:

# Roxygen documentation

#' Bastiat, please retrieve the characteristics of this detective.
#'
#' @return A list of characteristics.
#' @references www.globaltradealert.org
#' @author Johannes Fritz for GTA


# Function infos and parameters  --------------------------------------------

bt_get_detective_characteristics <- function(d.name=NULL,
                                             d.number=NULL,
                                             detective.log="content/0 core/Classifier statistics & history.Rdata") {

  load(detective.log)

  if(is.null(d.name) & is.null(d.number)){stop("Please specify detective.")}

  if(d.name=="incumbent"){
    detective.name=model$name[nrow(model)]
    detective.number=model$detective.no[nrow(model)]

    } else {

      if(is.null(d.number)){
        detective.number=max(subset(model, name==d.name)$detective.no)
      } else {
        detective.number=d.number
      }

      if(is.null(d.name)){
        detective.name=subset(model, detective.no==d.number)$name
      } else {
        detective.name=d.name
      }


    }

  variables=unique(unlist(strsplit(as.character(subset(model, name==detective.name & detective.no==detective.number)$my.vars), ";")))

  if("acting.agency" %in% variables){
    aa=TRUE
  } else {
    aa=FALSE
  }

  output.list<- list("detective.name"=detective.name,
                     "detective.number"=detective.number,
                     "variables"=variables,
                     "vars.incl.acting.agency"=aa,
                     "vars.incl.keywords"=any(c("pos.word","pos.word.char", "neg.word", "neg.word.char") %in% variables),
                     "vars.incl.td"="is.td" %in% variables,
                     "dtmatrix.included"=subset(model, name==detective.name & detective.no==detective.number)$dtm.incl,
                     "dtmatrix.metric"=subset(model, name==detective.name & detective.no==detective.number)$dtm.metric,
                     "dtmatrix.term.count"=subset(model, name==detective.name & detective.no==detective.number)$dtm.terms,
                     "estimation.model"=subset(model, name==detective.name & detective.no==detective.number)$estimation.method)

  return(output.list)
}