R/trim_signature_names.R

Defines functions trim_signature_names

Documented in trim_signature_names

#' Trims the names of mutation signatures
#'
#' Any signature names starting with "Signature" get trimmed.
#'
#' @param signature     A factor containing signature names.
#' @return A factor where all names starting with "Signature" are trimmed.
#'
#' @import magrittr

trim_signature_names <- function(signature, replace_string='Signature') {
  signature %>% 
    `levels<-`(
        trimws(
            gsub(replace_string, '', levels(signature)
            )
        )
    )
}
eyzhao/SignIT documentation built on Dec. 6, 2019, 11:45 a.m.