Header menu logo BioFSharp

AminoAcids Module

Functions and values

Function or value Description

oneLetterToOption character

Full Usage: oneLetterToOption character

Parameters:
    character : char - The input character to convert

Returns: AminoAcid option Some AminoAcid for valid AA codes, None otherwise

Converter function to return Some AminoAcid if the input character is a valid one-letter code. Returns None if the input is not a valid one-letter code.

character : char

The input character to convert

Returns: AminoAcid option

Some AminoAcid for valid AA codes, None otherwise

oneLetterToOptionStandard character

Full Usage: oneLetterToOptionStandard character

Parameters:
    character : char - The input character to convert

Returns: AminoAcid option Some AminoAcid for valid AA codes, None otherwise

Converter function to return Some AminoAcid if the input character is a valid one-letter code for standard amino acids. Returns None if the input an ambiguous code (e.g., 'X', 'Z', 'B', 'J'), or not a valid one-letter code.

character : char

The input character to convert

Returns: AminoAcid option

Some AminoAcid for valid AA codes, None otherwise

oneLetterToOptionStandardWithoutGapTer character

Full Usage: oneLetterToOptionStandardWithoutGapTer character

Parameters:
    character : char - The input character to convert

Returns: AminoAcid option Some AminoAcid for valid AA codes, None otherwise

Converter function to return Some AminoAcid if the input character is a valid one-letter code for standard amino acids, but no Gap or tertminator. Returns None if the input an ambiguous code (e.g., 'X', 'Z', 'B', 'J'), a Gap, a Terminator, or not a valid one-letter code.

character : char

The input character to convert

Returns: AminoAcid option

Some AminoAcid for valid AA codes, None otherwise

oneLetterToOptionWithoutGapTer character

Full Usage: oneLetterToOptionWithoutGapTer character

Parameters:
    character : char - The input character to convert

Returns: AminoAcid option Some AminoAcid for valid AA codes, None otherwise

Converter function to return Some AminoAcid if the input character is a valid one-letter code for standard or ambiguous amino acids, but no Gap or tertminator. Returns None if the input is a Gap, a Terminator, or not a valid one-letter code.

character : char

The input character to convert

Returns: AminoAcid option

Some AminoAcid for valid AA codes, None otherwise

threeLettersToOption characters

Full Usage: threeLettersToOption characters

Parameters:
    characters : 'a

Returns: AminoAcid option Some AminoAcid for valid AA codes, None otherwise

Converter function to return Some AminoAcid if the input characters are a valid three-letter code. Returns None if the input is not a valid one-letter code.

characters : 'a
Returns: AminoAcid option

Some AminoAcid for valid AA codes, None otherwise

Type something to start searching.