diff --git a/CHANGELOG.md b/CHANGELOG.md index 57839ed..cbafd7f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # Changelog +## [0.5.0] - TBD + +### BREAKING + +- Fix uncertain bases and amino acids format of ins and delins because HGVS nomenclature was updated. + - DNA: `ins(10)` -> `insN[10]` + - RNA: `ins(10)` -> `insn[10]` + - Protein: `ins10` -> `insX[10]` + +### Fixed + +- Fix uncertain insertion. [#10](https://github.com/chrovis/clj-hgvs/pull/10) + ## [0.4.7] - 2023-04-25 ### Fixed @@ -126,7 +139,8 @@ ## 0.1.0 - 2017-04-17 -[Unreleased]: https://github.com/chrovis/clj-hgvs/compare/0.4.7...HEAD +[Unreleased]: https://github.com/chrovis/clj-hgvs/compare/0.5.0...HEAD +[0.5.0]: https://github.com/chrovis/clj-hgvs/compare/0.4.7...0.5.0 [0.4.7]: https://github.com/chrovis/clj-hgvs/compare/0.4.6...0.4.7 [0.4.6]: https://github.com/chrovis/clj-hgvs/compare/0.4.5...0.4.6 [0.4.5]: https://github.com/chrovis/clj-hgvs/compare/0.4.4...0.4.5 diff --git a/README.md b/README.md index bbce2dc..083df28 100644 --- a/README.md +++ b/README.md @@ -19,18 +19,25 @@ clj-hgvs provides: Clojure CLI/deps.edn: ```clojure -clj-hgvs {:mvn/version "0.4.7"} +clj-hgvs {:mvn/version "0.5.0"} ``` Leiningen/Boot: ```clojure -[clj-hgvs "0.4.7"] +[clj-hgvs "0.5.0"] ``` To use clj-hgvs with Clojure 1.8, you must include a dependency on [clojure-future-spec](https://github.com/tonsky/clojure-future-spec). +## Breaking Changes in 0.5.0 + +- Fix uncertain bases and amino acids format of ins and delins because HGVS nomenclature was updated. + - DNA: `ins(10)` -> `insN[10]` + - RNA: `ins(10)` -> `insn[10]` + - Protein: `ins10` -> `insX[10]` + ## Breaking Changes in 0.4.0 - HGVS data structure changes from map to record (`clj-hgvs.core/HGVS`). @@ -170,6 +177,6 @@ You may supply custom repair rules to the second argument: ## License -Copyright 2017-2023 [Xcoo, Inc.](https://xcoo.jp/) +Copyright 2017-2024 [Xcoo, Inc.](https://xcoo.jp/) Licensed under the [Apache License, Version 2.0](LICENSE). diff --git a/docs/clj-hgvs.coordinate.html b/docs/clj-hgvs.coordinate.html index 779fa0e..9ae3c0b 100644 --- a/docs/clj-hgvs.coordinate.html +++ b/docs/clj-hgvs.coordinate.html @@ -1,27 +1,27 @@ -clj-hgvs.coordinate documentation

clj-hgvs.coordinate

Data structures and functions to handle HGVS coordinates.
-

->region-keyword

(->region-keyword s)

->region-str

(->region-str k)

Calculable

protocol

members

minus

(minus this n)
Subtracts n from the given coordinate and returns the new coordinate.
+clj-hgvs.coordinate documentation

clj-hgvs.coordinate

Data structures and functions to handle HGVS coordinates.
+

->region-keyword

(->region-keyword s)

->region-str

(->region-str k)

Calculable

protocol

members

minus

(minus this n)
Subtracts n from the given coordinate and returns the new coordinate.
 

plus

(plus this n)
Adds n to the given coordinate and returns the new coordinate.
-

circular-dna-coordinate

(circular-dna-coordinate position)
Returns CircularDNACoordinate instance having position. Throws an exception
-if position is illegal.

coding-dna-coordinate

(coding-dna-coordinate position)(coding-dna-coordinate position offset region)
Returns CodingDNACoordinate instance having position, offset, and region.
-Throws an exception if any input is illegal.

comparable-coordinates?

(comparable-coordinates? coord1 coord2)
Returns true if the two coordinates are comparable, else false.
-

Coordinate

protocol

members

format

(format this)
Returns a string representing the given coordinate.
+

circular-dna-coordinate

(circular-dna-coordinate position)
Returns CircularDNACoordinate instance having position. Throws an exception
+if position is illegal.

coding-dna-coordinate

(coding-dna-coordinate position)(coding-dna-coordinate position offset region)
Returns CodingDNACoordinate instance having position, offset, and region.
+Throws an exception if any input is illegal.

comparable-coordinates?

(comparable-coordinates? coord1 coord2)
Returns true if the two coordinates are comparable, else false.
+

Coordinate

protocol

members

format

(format this)
Returns a string representing the given coordinate.
 

plain

(plain this)
Returns a plain map representing the given coordinate.
-

genomic-coordinate

(genomic-coordinate position)
Returns GenomicCoordinate instance having position. Throws an exception if
-position is illegal.

ICodingDNACoordinate

protocol

members

in-exon?

(in-exon? this)
Returns true if the coordinate is located in exon, else false.
-

mitochondrial-coordinate

(mitochondrial-coordinate position)
Returns MitochondrialCoordinate instance having position. Throws an exception
-if position is illegal.

non-coding-dna-coordinate

(non-coding-dna-coordinate position)
Returns NonCodingDNACoordinate instance having position. Throws an exception
-if position is illegal.

parse-circular-dna-coordinate

(parse-circular-dna-coordinate s)
Parses a coordinate string used in circular-dna mutations, returning a
-CircularDNACoordinate or UnknownCoordinate.

parse-coding-dna-coordinate

(parse-coding-dna-coordinate s)
Parses a coordinate string used in coding DNA mutations, returning a
-CodingDNACoordinate or UnknownCoordinate.

parse-coordinate

(parse-coordinate s t)

parse-genomic-coordinate

(parse-genomic-coordinate s)
Parses a coordinate string used in genomic mutations, returning a
-GenomicCoordinate or UnknownCoordinate.

parse-mitochondrial-coordinate

(parse-mitochondrial-coordinate s)
Parses a coordinate string used in mitochondrial mutations, returning a
-MitochondrialCoordinate or UnknownCoordinate.

parse-non-coding-dna-coordinate

(parse-non-coding-dna-coordinate s)
Parses a coordinate string used in non-coding DNA mutations, returning a
-NonCodingDNACoordinate or UnknownCoordinate.

parse-protein-coordinate

(parse-protein-coordinate s)
Parses a coordinate string used in protein mutations, returning a
-ProteinCoordinate or UnknownCoordinate.

parse-rna-coordinate

(parse-rna-coordinate s)
Parses a coordinate string used in RNA mutations, returning a RNACoordinate
-or UnknownCoordinate.

parse-uncertain-coordinate

(parse-uncertain-coordinate s t)

protein-coordinate

(protein-coordinate position)
Returns ProteinCoordinate instance having position. Throws an exception if
-position is illegal.

restore

multimethod

(restore m)
Restores a plain map to a suitable coordinate record.
-

rna-coordinate

(rna-coordinate position offset region)
Returns RNACoordinate instance having position, offset, and region. Throws an
-exception if any input is illegal.

uncertain-coordinate

(uncertain-coordinate start end)
Returns UncertainCoordinate instance having start and end. Throws an
-exception if any input is illegal.

unknown-coordinate

(unknown-coordinate)
Returns UnknownCoordinate instance.
-
\ No newline at end of file +

genomic-coordinate

(genomic-coordinate position)
Returns GenomicCoordinate instance having position. Throws an exception if
+position is illegal.

ICodingDNACoordinate

protocol

members

in-exon?

(in-exon? this)
Returns true if the coordinate is located in exon, else false.
+

mitochondrial-coordinate

(mitochondrial-coordinate position)
Returns MitochondrialCoordinate instance having position. Throws an exception
+if position is illegal.

non-coding-dna-coordinate

(non-coding-dna-coordinate position)
Returns NonCodingDNACoordinate instance having position. Throws an exception
+if position is illegal.

parse-circular-dna-coordinate

(parse-circular-dna-coordinate s)
Parses a coordinate string used in circular-dna mutations, returning a
+CircularDNACoordinate or UnknownCoordinate.

parse-coding-dna-coordinate

(parse-coding-dna-coordinate s)
Parses a coordinate string used in coding DNA mutations, returning a
+CodingDNACoordinate or UnknownCoordinate.

parse-coordinate

(parse-coordinate s t)

parse-genomic-coordinate

(parse-genomic-coordinate s)
Parses a coordinate string used in genomic mutations, returning a
+GenomicCoordinate or UnknownCoordinate.

parse-mitochondrial-coordinate

(parse-mitochondrial-coordinate s)
Parses a coordinate string used in mitochondrial mutations, returning a
+MitochondrialCoordinate or UnknownCoordinate.

parse-non-coding-dna-coordinate

(parse-non-coding-dna-coordinate s)
Parses a coordinate string used in non-coding DNA mutations, returning a
+NonCodingDNACoordinate or UnknownCoordinate.

parse-protein-coordinate

(parse-protein-coordinate s)
Parses a coordinate string used in protein mutations, returning a
+ProteinCoordinate or UnknownCoordinate.

parse-rna-coordinate

(parse-rna-coordinate s)
Parses a coordinate string used in RNA mutations, returning a RNACoordinate
+or UnknownCoordinate.

parse-uncertain-coordinate

(parse-uncertain-coordinate s t)

protein-coordinate

(protein-coordinate position)
Returns ProteinCoordinate instance having position. Throws an exception if
+position is illegal.

restore

multimethod

(restore m)
Restores a plain map to a suitable coordinate record.
+

rna-coordinate

(rna-coordinate position offset region)
Returns RNACoordinate instance having position, offset, and region. Throws an
+exception if any input is illegal.

uncertain-coordinate

(uncertain-coordinate start end)
Returns UncertainCoordinate instance having start and end. Throws an
+exception if any input is illegal.

unknown-coordinate

(unknown-coordinate)
Returns UnknownCoordinate instance.
+
\ No newline at end of file diff --git a/docs/clj-hgvs.core.html b/docs/clj-hgvs.core.html index 192b408..5aeedc8 100644 --- a/docs/clj-hgvs.core.html +++ b/docs/clj-hgvs.core.html @@ -1,12 +1,12 @@ -clj-hgvs.core documentation

clj-hgvs.core

Main functions for handling HGVS. See http://varnomen.hgvs.org/ for the
+clj-hgvs.core documentation

clj-hgvs.core

Main functions for handling HGVS. See http://varnomen.hgvs.org/ for the
 detail HGVS nomenclature.

==

(== hgvs)(== hgvs1 hgvs2)(== hgvs1 hgvs2 & more)
Returns true if hgvs1 is equivalent to hgvs2, false otherwise.
 
 This function compares the fundamental equivalence of the given HGVS, ignoring
 the difference of the transcript version, the short/long amino acid style, and
-the description of the same mutation.

data-readers

Tagged literal support if loader does not find "data_readers.clj".
-

format

(format hgvs)(format hgvs opts)
Returns a HGVS string representing the given HGVS map.
+the description of the same mutation.

data-readers

Tagged literal support if loader does not find "data_readers.clj".
+

format

(format hgvs)(format hgvs opts)
Returns a HGVS string representing the given HGVS map.
 
 The second argument is an optional map to specify style:
 
@@ -25,7 +25,7 @@
                        default false.
 
    :ter-format         Ter codon style of protein frame shift and extension,
-                       default :long. <:long|:short>}

hgvs

(hgvs transcript kind mutation)
Creates HGVS data represented as a record.
+                       default :long. <:long|:short>}

hgvs

(hgvs transcript kind mutation)
Creates HGVS data represented as a record.
 
 transcript is nilable for conventional reasons, but you should supply it if
 possible.
@@ -34,13 +34,13 @@
 :circular-dna, :rna, and :protein.
 
 mutation must be a clj-hgvs.mutation record or string. The string mutation
-will be parsed by clj-hgvs.mutation/parse.

normalize

(normalize s)
Reformats the HGVS string s, returning the normalized HGVS string.
+will be parsed by clj-hgvs.mutation/parse.

normalize

(normalize s)
Reformats the HGVS string s, returning the normalized HGVS string.
 
 The default style will be used for reformatting. See clj-hgvs.core/format
-document for further details of the style options.

parse

(parse s)
Parses a HGVS string s, returning a map representing the HGVS.
-

plain

(plain hgvs)
Returns a plain map representing the given HGVS. This function is useful for
+document for further details of the style options.

parse

(parse s)
Parses a HGVS string s, returning a map representing the HGVS.
+

plain

(plain hgvs)
Returns a plain map representing the given HGVS. This function is useful for
 sending data through another codec. Use clj-hgvs.core/restore to retrieve
-original HGVS data.

repair-hgvs-str

(repair-hgvs-str s)(repair-hgvs-str s repairers)
Attempts to repair an invalid HGVS string, returning a correct HGVS string.
+original HGVS data.

repair-hgvs-str

(repair-hgvs-str s)(repair-hgvs-str s repairers)
Attempts to repair an invalid HGVS string, returning a correct HGVS string.
 
 The repair rules are based on frequent mistakes in popular public-domain
 databases such as dbSNP and ClinVar. See clj-hgvs.repairer/built-in-repairers
@@ -58,9 +58,9 @@
                           lower-case-ext))
 
   (repair-hgvs-str "p.*833EXT*?" my-repairers)
-  => "p.*833ext*?"

restore

(restore m)
Restores a plain map to a suitable HGVS data structure. This function is
-useful for sending data through another codec.

with-validation-disabled

macro

(with-validation-disabled & body)
Disables validation within a scope.
+  => "p.*833ext*?"

restore

(restore m)
Restores a plain map to a suitable HGVS data structure. This function is
+useful for sending data through another codec.

with-validation-disabled

macro

(with-validation-disabled & body)
Disables validation within a scope.
 
 HGVS data are checked upon interpretation phases by default, but in the scope,
 all validations will be skipped. This macro may improve the performance on
-handling HGVS which validity is already known.
\ No newline at end of file +handling HGVS which validity is already known.
\ No newline at end of file diff --git a/docs/clj-hgvs.mutation.html b/docs/clj-hgvs.mutation.html index ae4e0f5..49915c7 100644 --- a/docs/clj-hgvs.mutation.html +++ b/docs/clj-hgvs.mutation.html @@ -1,41 +1,41 @@ -clj-hgvs.mutation documentation

clj-hgvs.mutation

Data structures and functions to handle HGVS mutations.
+clj-hgvs.mutation documentation

clj-hgvs.mutation

Data structures and functions to handle HGVS mutations.
 

->long-amino-acid

(->long-amino-acid s)
Converts a single-letter amino acid into a three-letter one. s must be String
-or Character. Returns nil if s is not present in amino acid list.

->short-amino-acid

(->short-amino-acid s)
Converts a three-letter amino acid into a single-letter one. s must be String
-or Character. Returns nil if s is not present in amino acid list.

dna-alleles

(dna-alleles mutations1 mutations2)

dna-conversion

(dna-conversion coord-start coord-end alt)
Constructor of DNAConversion. Throws an exception if any input is illegal.
-

dna-deletion

(dna-deletion coord-start coord-end)(dna-deletion coord-start coord-end ref)
Constructor of DNADeletion. Throws an exception if any input is illegal.
-

dna-duplication

(dna-duplication coord-start coord-end)(dna-duplication coord-start coord-end ref)
Constructor of DNADuplication. Throws an exception if any input is illegal.
-

dna-indel

(dna-indel coord-start coord-end ref alt)
Constructor of DNAIndel. Throws an exception if any input is illegal.
-

dna-insertion

(dna-insertion coord-start coord-end alt)
Constructor of DNAInsertion. Throws an exception if any input is illegal.
-

dna-inversion

(dna-inversion coord-start coord-end)
Constructor of DNAInversion. Throws an exception if any input is illegal.
-

dna-repeated-seqs

(dna-repeated-seqs coord-start coord-end ref ncopy)
Constructor of DNARepeatedSeqs. Throws an exception if any input is illegal.
-

dna-substitution

(dna-substitution coord ref typ)(dna-substitution coord ref typ alt)
Constructor of DNASubstitution. Throws an exception if any input is illegal.
-

equiv

(equiv mutation1 mutation2)

Equivalence

protocol

members

equiv*

(equiv* this o)

long-amino-acids

A list of three-letter amino acids.
-

Mutation

protocol

members

format

(format this)(format this opts)
Returns a string representing the given mutation. The second argument is an
+or Character. Returns nil if s is not present in amino acid list.

->short-amino-acid

(->short-amino-acid s)
Converts a three-letter amino acid into a single-letter one. s must be String
+or Character. Returns nil if s is not present in amino acid list.

dna-alleles

(dna-alleles mutations1 mutations2)

dna-conversion

(dna-conversion coord-start coord-end alt)
Constructor of DNAConversion. Throws an exception if any input is illegal.
+

dna-deletion

(dna-deletion coord-start coord-end)(dna-deletion coord-start coord-end ref)
Constructor of DNADeletion. Throws an exception if any input is illegal.
+

dna-duplication

(dna-duplication coord-start coord-end)(dna-duplication coord-start coord-end ref)
Constructor of DNADuplication. Throws an exception if any input is illegal.
+

dna-indel

(dna-indel coord-start coord-end ref alt)
Constructor of DNAIndel. Throws an exception if any input is illegal.
+

dna-insertion

(dna-insertion coord-start coord-end alt)
Constructor of DNAInsertion. Throws an exception if any input is illegal.
+

dna-inversion

(dna-inversion coord-start coord-end)
Constructor of DNAInversion. Throws an exception if any input is illegal.
+

dna-repeated-seqs

(dna-repeated-seqs coord-start coord-end ref ncopy)
Constructor of DNARepeatedSeqs. Throws an exception if any input is illegal.
+

dna-substitution

(dna-substitution coord ref typ)(dna-substitution coord ref typ alt)
Constructor of DNASubstitution. Throws an exception if any input is illegal.
+

equiv

(equiv mutation1 mutation2)

Equivalence

protocol

members

equiv*

(equiv* this o)

long-amino-acids

A list of three-letter amino acids.
+

Mutation

protocol

members

format

(format this)(format this opts)
Returns a string representing the given mutation. The second argument is an
 optional map to specify style. See document of clj-hgvs.core/format for
 details of the option.

plain

(plain this)
Returns a plain map representing the given mutation.
-

no-protein

(no-protein)

no-rna

(no-rna)

parse

(parse s kind)

parse-dna

(parse-dna s kind)
Parses a DNA mutation string s, returning a record implementing Mutation
+

no-protein

(no-protein)

no-rna

(no-rna)

parse

(parse s kind)

parse-dna

(parse-dna s kind)
Parses a DNA mutation string s, returning a record implementing Mutation
 protocol. kind must be selected from :genome, :mitochondria, :coding-dna, or
-:non-coding-dna.

parse-dna-alleles

(parse-dna-alleles s kind)

parse-dna-conversion

(parse-dna-conversion s kind)

parse-dna-deletion

(parse-dna-deletion s kind)

parse-dna-duplication

(parse-dna-duplication s kind)

parse-dna-indel

(parse-dna-indel s kind)

parse-dna-insertion

(parse-dna-insertion s kind)

parse-dna-inversion

(parse-dna-inversion s kind)

parse-dna-repeated-seqs

(parse-dna-repeated-seqs s kind)

parse-dna-substitution

(parse-dna-substitution s kind)

parse-protein

(parse-protein s)
Parses a protein mutation string s, returning a record implementing Mutation
-protocol.

parse-protein-alleles

(parse-protein-alleles s)

parse-protein-deletion

(parse-protein-deletion s)

parse-protein-duplication

(parse-protein-duplication s)

parse-protein-extension

(parse-protein-extension s)

parse-protein-frame-shift

(parse-protein-frame-shift s)

parse-protein-indel

(parse-protein-indel s)

parse-protein-insertion

(parse-protein-insertion s)

parse-protein-repeated-seqs

(parse-protein-repeated-seqs s)

parse-protein-substitution

(parse-protein-substitution s)

parse-rna

(parse-rna s)
Parses a RNA mutation string s, returning a record implementing Mutation
-protocol.

parse-rna-alleles

(parse-rna-alleles s)

parse-rna-conversion

(parse-rna-conversion s)

parse-rna-deletion

(parse-rna-deletion s)

parse-rna-duplication

(parse-rna-duplication s)

parse-rna-indel

(parse-rna-indel s)

parse-rna-insertion

(parse-rna-insertion s)

parse-rna-inversion

(parse-rna-inversion s)

parse-rna-repeated-seqs

(parse-rna-repeated-seqs s)

parse-rna-substitution

(parse-rna-substitution s)

parse-uncertain-mutation

(parse-uncertain-mutation s kind)

protein-alleles

(protein-alleles mutations1 mutations2)

protein-deletion

(protein-deletion ref-start coord-start)(protein-deletion ref-start coord-start ref-end coord-end)
Constructor of ProteinDeletion. Throws an exception if any input is illegal.
-

protein-duplication

(protein-duplication ref-start coord-start)(protein-duplication ref-start coord-start ref-end coord-end)
Constructor of ProteinDuplication. Throws an exception if any input is illegal.
-

protein-extension

(protein-extension ref coord alt region new-site)
Constructor of ProteinExtension. Throws an exception if any input is illegal.
-

protein-frame-shift

(protein-frame-shift ref coord alt new-ter-site)
Constructor of ProteinFrameShift. Throws an exception if any input is illegal.
-

protein-indel

(protein-indel ref-start coord-start ref-end coord-end alts)
Constructor of ProteinIndel. Throws an exception if any input is illegal.
-

protein-insertion

(protein-insertion ref-start coord-start ref-end coord-end alts)
Constructor of ProteinInsertion. Throws an exception if any input is illegal.
-

protein-no-effect

(protein-no-effect)

protein-repeated-seqs

(protein-repeated-seqs ref-start coord-start ref-end coord-end ncopy)
Constructor of ProteinRepeatedSeqs. Throws an exception if any input is illegal.
-

protein-substitution

(protein-substitution ref coord alt)
Constructor of ProteinSubstitution. Throws an exception if any input is illegal.
-

protein-unknown-mutation

(protein-unknown-mutation)

restore

multimethod

(restore m)
Restores a plain map to a suitable mutation record.
-

rna-alleles

(rna-alleles mutations1 mutations2)

rna-conversion

(rna-conversion coord-start coord-end alt)
Constructor of RNAConversion. Throws an exception if any input is illegal.
-

rna-deletion

(rna-deletion coord-start coord-end)(rna-deletion coord-start coord-end ref)
Constructor of DNAdeletion. Throws an exception if any input is illegal.
-

rna-duplication

(rna-duplication coord-start coord-end)(rna-duplication coord-start coord-end ref)
Constructor of RNADuplication. Throws an exception if any input is illegal.
-

rna-indel

(rna-indel coord-start coord-end ref alt)
Constructor of RNAIndel. Throws an exception if any input is illegal.
-

rna-insertion

(rna-insertion coord-start coord-end alt)
Constructor of RNAInsertion. Throws an exception if any input is illegal.
-

rna-inversion

(rna-inversion coord-start coord-end)
Constructor of RNAInversion. Throws an exception if any input is illegal.
-

rna-no-effect

(rna-no-effect)

rna-repeated-seqs

(rna-repeated-seqs coord-start coord-end ref ncopy)
Constructor of RNARepeatedSeqs. Throws an exception if any input is illegal.
-

rna-splice-affected

(rna-splice-affected)

rna-substitution

(rna-substitution coord ref alt)
Constructor of RNASubstitution. Throws an exception if any input is illegal.
-

rna-unknown-mutation

(rna-unknown-mutation)

SeparatelyFormat

protocol

members

format-common

(format-common this opts)

format-unique

(format-unique this opts)

short-amino-acids

A list of single-letter amino acids.
-

uncertain-mutation

(uncertain-mutation mutation)
Constructor of UncertainMutation. Throws an exception if any input is
-illegal.
\ No newline at end of file +:non-coding-dna.

parse-dna-alleles

(parse-dna-alleles s kind)

parse-dna-conversion

(parse-dna-conversion s kind)

parse-dna-deletion

(parse-dna-deletion s kind)

parse-dna-duplication

(parse-dna-duplication s kind)

parse-dna-indel

(parse-dna-indel s kind)

parse-dna-insertion

(parse-dna-insertion s kind)

parse-dna-inversion

(parse-dna-inversion s kind)

parse-dna-repeated-seqs

(parse-dna-repeated-seqs s kind)

parse-dna-substitution

(parse-dna-substitution s kind)

parse-protein

(parse-protein s)
Parses a protein mutation string s, returning a record implementing Mutation
+protocol.

parse-protein-alleles

(parse-protein-alleles s)

parse-protein-deletion

(parse-protein-deletion s)

parse-protein-duplication

(parse-protein-duplication s)

parse-protein-extension

(parse-protein-extension s)

parse-protein-frame-shift

(parse-protein-frame-shift s)

parse-protein-indel

(parse-protein-indel s)

parse-protein-insertion

(parse-protein-insertion s)

parse-protein-repeated-seqs

(parse-protein-repeated-seqs s)

parse-protein-substitution

(parse-protein-substitution s)

parse-rna

(parse-rna s)
Parses a RNA mutation string s, returning a record implementing Mutation
+protocol.

parse-rna-alleles

(parse-rna-alleles s)

parse-rna-conversion

(parse-rna-conversion s)

parse-rna-deletion

(parse-rna-deletion s)

parse-rna-duplication

(parse-rna-duplication s)

parse-rna-indel

(parse-rna-indel s)

parse-rna-insertion

(parse-rna-insertion s)

parse-rna-inversion

(parse-rna-inversion s)

parse-rna-repeated-seqs

(parse-rna-repeated-seqs s)

parse-rna-substitution

(parse-rna-substitution s)

parse-uncertain-mutation

(parse-uncertain-mutation s kind)

protein-alleles

(protein-alleles mutations1 mutations2)

protein-deletion

(protein-deletion ref-start coord-start)(protein-deletion ref-start coord-start ref-end coord-end)
Constructor of ProteinDeletion. Throws an exception if any input is illegal.
+

protein-duplication

(protein-duplication ref-start coord-start)(protein-duplication ref-start coord-start ref-end coord-end)
Constructor of ProteinDuplication. Throws an exception if any input is illegal.
+

protein-extension

(protein-extension ref coord alt region new-site)
Constructor of ProteinExtension. Throws an exception if any input is illegal.
+

protein-frame-shift

(protein-frame-shift ref coord alt new-ter-site)
Constructor of ProteinFrameShift. Throws an exception if any input is illegal.
+

protein-indel

(protein-indel ref-start coord-start ref-end coord-end alts)
Constructor of ProteinIndel. Throws an exception if any input is illegal.
+

protein-insertion

(protein-insertion ref-start coord-start ref-end coord-end alts)
Constructor of ProteinInsertion. Throws an exception if any input is illegal.
+

protein-no-effect

(protein-no-effect)

protein-repeated-seqs

(protein-repeated-seqs ref-start coord-start ref-end coord-end ncopy)
Constructor of ProteinRepeatedSeqs. Throws an exception if any input is illegal.
+

protein-substitution

(protein-substitution ref coord alt)
Constructor of ProteinSubstitution. Throws an exception if any input is illegal.
+

protein-unknown-mutation

(protein-unknown-mutation)

restore

multimethod

(restore m)
Restores a plain map to a suitable mutation record.
+

rna-alleles

(rna-alleles mutations1 mutations2)

rna-conversion

(rna-conversion coord-start coord-end alt)
Constructor of RNAConversion. Throws an exception if any input is illegal.
+

rna-deletion

(rna-deletion coord-start coord-end)(rna-deletion coord-start coord-end ref)
Constructor of DNAdeletion. Throws an exception if any input is illegal.
+

rna-duplication

(rna-duplication coord-start coord-end)(rna-duplication coord-start coord-end ref)
Constructor of RNADuplication. Throws an exception if any input is illegal.
+

rna-indel

(rna-indel coord-start coord-end ref alt)
Constructor of RNAIndel. Throws an exception if any input is illegal.
+

rna-insertion

(rna-insertion coord-start coord-end alt)
Constructor of RNAInsertion. Throws an exception if any input is illegal.
+

rna-inversion

(rna-inversion coord-start coord-end)
Constructor of RNAInversion. Throws an exception if any input is illegal.
+

rna-no-effect

(rna-no-effect)

rna-repeated-seqs

(rna-repeated-seqs coord-start coord-end ref ncopy)
Constructor of RNARepeatedSeqs. Throws an exception if any input is illegal.
+

rna-splice-affected

(rna-splice-affected)

rna-substitution

(rna-substitution coord ref alt)
Constructor of RNASubstitution. Throws an exception if any input is illegal.
+

rna-unknown-mutation

(rna-unknown-mutation)

SeparatelyFormat

protocol

members

format-common

(format-common this opts)

format-unique

(format-unique this opts)

short-amino-acids

A list of single-letter amino acids.
+

uncertain-mutation

(uncertain-mutation mutation)
Constructor of UncertainMutation. Throws an exception if any input is
+illegal.
\ No newline at end of file diff --git a/docs/clj-hgvs.repairer.html b/docs/clj-hgvs.repairer.html index 5bdaa34..f705671 100644 --- a/docs/clj-hgvs.repairer.html +++ b/docs/clj-hgvs.repairer.html @@ -1,6 +1,6 @@ -clj-hgvs.repairer documentation

clj-hgvs.repairer

HGVS repair functions.
+clj-hgvs.repairer documentation

clj-hgvs.repairer

HGVS repair functions.
 

built-in-repairers

The built-in repair functions.
 
 A repair fn must take a HGVS string and an inferred kind, and return a
@@ -13,5 +13,5 @@
       s))
 
 The built-in rules are based on frequent mistakes in popular public-domain
-databases such as dbSNP and ClinVar.

infer-kind

(infer-kind s)
Infers a kind from the provided string, returning the kind keyword.
-
\ No newline at end of file +databases such as dbSNP and ClinVar.

infer-kind

(infer-kind s)
Infers a kind from the provided string, returning the kind keyword.
+
\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 44dd367..b6229dd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -clj-hgvs 0.4.7

clj-hgvs 0.4.7

Released under the Apache License, Version 2.0

Clojure(Script) library for handling HGVS.

Installation

To install, add the following dependency to your project or build file:

[clj-hgvs "0.4.7"]

Namespaces

clj-hgvs.coordinate

Data structures and functions to handle HGVS coordinates.

clj-hgvs.core

Main functions for handling HGVS. See http://varnomen.hgvs.org/ for the
+clj-hgvs 0.5.0

clj-hgvs 0.5.0

Released under the Apache License, Version 2.0

Clojure(Script) library for handling HGVS.

Installation

To install, add the following dependency to your project or build file:

[clj-hgvs "0.5.0"]

Namespaces

clj-hgvs.core

Main functions for handling HGVS. See http://varnomen.hgvs.org/ for the
 detail HGVS nomenclature.

clj-hgvs.repairer

HGVS repair functions.

Public variables and functions:

\ No newline at end of file diff --git a/project.clj b/project.clj index d0d6315..92ddb46 100644 --- a/project.clj +++ b/project.clj @@ -1,4 +1,4 @@ -(defproject clj-hgvs "0.5.0-SNAPSHOT" +(defproject clj-hgvs "0.5.0" :description "Clojure(Script) library for handling HGVS" :url "https://github.com/chrovis/clj-hgvs" :license {:name "Apache License, Version 2.0"