TimothyStiles/poly

View on GitHub
seqhash/seqhash.go

Summary

Maintainability
A
0 mins
Test Coverage

Function Hash has a Cognitive Complexity of 28 (exceeds 20 allowed). Consider refactoring.
Wontfix

func Hash(sequence string, sequenceType string, circular bool, doubleStranded bool) (string, error) {
    // By definition, Seqhashes are of uppercase sequences
    sequence = strings.ToUpper(sequence)
    // If RNA, convert to a DNA sequence. The hash itself between a DNA and RNA sequence will not
    // be different, but their Seqhash will have a different metadata string (R vs D)
Severity: Minor
Found in seqhash/seqhash.go - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function Hash has 63 lines of code (exceeds 50 allowed). Consider refactoring.
Wontfix

func Hash(sequence string, sequenceType string, circular bool, doubleStranded bool) (string, error) {
    // By definition, Seqhashes are of uppercase sequences
    sequence = strings.ToUpper(sequence)
    // If RNA, convert to a DNA sequence. The hash itself between a DNA and RNA sequence will not
    // be different, but their Seqhash will have a different metadata string (R vs D)
Severity: Minor
Found in seqhash/seqhash.go - About 1 hr to fix

    Function Hash has 5 return statements (exceeds 4 allowed).
    Wontfix

    func Hash(sequence string, sequenceType string, circular bool, doubleStranded bool) (string, error) {
        // By definition, Seqhashes are of uppercase sequences
        sequence = strings.ToUpper(sequence)
        // If RNA, convert to a DNA sequence. The hash itself between a DNA and RNA sequence will not
        // be different, but their Seqhash will have a different metadata string (R vs D)
    Severity: Major
    Found in seqhash/seqhash.go - About 35 mins to fix

      Your code does not pass gofmt in 1 place. Go fmt your code!
      Open

      /*
      Severity: Minor
      Found in seqhash/seqhash.go by gofmt

      There are no issues that match your filters.

      Category
      Status