R/ScaledChiSquare.R

#' @title Scaled Chi-Square
#'
#' @description
#' \code{ScaledChiSquare} Computes the Scaled Chi-Square Index for a Gene
#'
#' @details
#' Should be implemented because missing in Darwin
#'
#' @param cds Coding Sequence
#' @return VOID
#'
#' @author Siegrist, F. and Cannarozzi, G. M. \email{gina@@cannarozzi.com}
#' @seealso \code{\link{seqinr}} \code{\link{statanacoseq}}
#' @keywords CodonBias
#' @examples
#' ScaledChiSquare('ATGTGGTACTCCGACTACGGAGGATAA')
#' ScaledChiSquare(c2s(mylist(whatout=1)[[1]]))
#'
#' @import seqinr
#'
#' @export
#' @section Original code in Darwin:
#' \subsection{Scaled Chi-Square.}{\preformatted{
#' ScaledChiSquare := proc(d:string)
#' # to be implemented
#' end: } }

  ScaledChiSquare <- function(cds) {
  # to be implemented
}
fredysiegrist/statanacoseq documentation built on May 16, 2019, 2:44 p.m.