EML4_ALK_detection()

This function looks for EML4-ALK mate pair reads in the BAM file.

Input: $$\\[0.1in]$$

file

The name of the file which the data are to be read from.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can either be "hg38" or "hg19". 
Default = "hg38".

$$\\[0.1in]$$

mates

integer, the minimum number EML4-ALK mate pairs needed to be
detected in order to call a variant. Default = 2.

$$\\[0.1in]$$

Output:

A GAlignments object with soft-clipped reads representing EML4-ALK is returned. If no EML4-ALK is detected the the GAlignments is empty.

Examples:

H3122_result <- EML4_ALK_detection(file = H3122_bam, 
                        genome = "hg38", 
                        mates = 2) 
head(H3122_result)
#> GAlignments object with 6 alignments and 2 metadata columns:
#>       seqnames strand       cigar    qwidth     start       end     width
#>          <Rle>  <Rle> <character> <integer> <integer> <integer> <integer>
#>   [1]     chr2      +       94M2S        96  42299657  42299750        94
#>   [2]     chr2      +       92M4S        96  42299659  42299750        92
#>   [3]     chr2      +       92M4S        96  42299659  42299750        92
#>   [4]     chr2      +       91M5S        96  42299660  42299750        91
#>   [5]     chr2      +       91M5S        96  42299660  42299750        91
#>   [6]     chr2      +       87M9S        96  42299664  42299750        87
#>           njunc |      mpos                     seq
#>       <integer> | <integer>          <DNAStringSet>
#>   [1]         0 |  29223479 TTGCTTCTTT...GCAGTGGTCT
#>   [2]         0 |  29223606 GCTTCTTTCA...AGTGGTCTGA
#>   [3]         0 |  29223573 GCTTCTTTCA...AGTGGTCTGA
#>   [4]         0 |  29223650 CTTCTTTCAC...GTGGTCTGAT
#>   [5]         0 |  29223601 CTTCTTTCAC...GTGGTCTGAT
#>   [6]         0 |  29223640 TTTCACTTAG...TCTGATTTTT
#>   -------
#>   seqinfo: 455 sequences from an unspecified genome

HCC827_result <- EML4_ALK_detection(file = HCC827_bam, 
                    genome = "hg38", 
                    mates = 2)
HCC827_result
#> GAlignments object with 0 alignments and 0 metadata columns:
#>    seqnames strand       cigar    qwidth     start       end     width
#>       <Rle>  <Rle> <character> <integer> <integer> <integer> <integer>
#>        njunc
#>    <integer>
#>   -------
#>   seqinfo: no sequences

EML4_sequence()

This function identifies the basepairs leading up to the EML4 breakpoint.

Input: $$\\[0.1in]$$

reads

GAlignments object returned by EML4_ALK_detection().

$$\\[0.1in]$$

basepairs

integer, number of basepairs identified from the EML4-ALK fusion.
Default = 20.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can either be "hg38" or "hg19". 
Default = "hg38".

$$\\[0.1in]$$

Output:

If EML4-ALK is detected, returns a table of identified EML4 basepairs with the number of corresponding reads for each sequence. If no EML4-ALK is detected “No EML4-ALK was detected” is returned.

Examples:

EML4_sequence(H3122_result, genome = "hg38", basepairs = 20)
#> EML4_seq
#> CCAGGCTGGAGTGCAGTGGT GGAGTGCAGTGGTGTGATTT TCAGGCTGGAGTGCAGTGGT 
#>                   24                    1                    1
EML4_sequence(HCC827_result, genome = "hg38", basepairs = 20)
#> [1] "No EML4-ALK was detected"

ALK_sequence()

This function identifies the basepairs following the ALK breakpoint.

Input: $$\\[0.1in]$$

reads

GAlignments object returned by EML4_ALK_detection().

$$\\[0.1in]$$

basepairs

integer, number of basepairs identified from the EML4-ALK fusion. 
Default = 20.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can either be "hg38" or "hg19". 
Default = "hg38".

$$\\[0.1in]$$

Output:

If EML4-ALK is detected, returns a table of identified ALK basepairs with the number of corresponding reads for each sequence. If no spanning reads in ALK is detected an empty GAlignments object is returned. If no EML4-ALK is detected “No EML4-ALK was detected” is returned.

Examples:

ALK_sequence(H3122_result, genome = "hg38", basepairs = 20)
#> ALK_seq
#> AATGCAAAGCTAAAAATCAG ATGCAAAGCTAAAAATCAGA 
#>                    1                   36
ALK_sequence(HCC827_result, genome = "hg38", basepairs = 20)
#> [1] "No EML4-ALK was detected"

break_position()

This function identifies the genomic position in EML4 or ALK, where the breakpoint has happened.

Input: $$\\[0.1in]$$

reads

GAlignments object returned by EML4_ALK_detection().

$$\\[0.1in]$$ genome

character representing the reference genome. 
Can either be "hg38" or "hg19". 
Default = "hg38".

$$\\[0.1in]$$

gene

Character string representing the gene. Can be either "ALK" or "EML4".

$$\\[0.1in]$$

Output:

If EML4-ALK is detected, it returns a table of genomic positions with the number of corresponding reads for each sequence. If no spanning reads in EML4 or ALK is detected an empty GAlignments object is returned. If no EML4-ALK is detected “No EML4-ALK was detected” is returned.

Examples:

break_position(H3122_result, genome = "hg38", gene = "EML4")
#> break_pos
#> 42299750 42299757 
#>       25        1
break_position(HCC827_result, genome = "hg38", gene = "EML4")
#> [1] "No EML4-ALK was detected"

break_position_depth()

This function identifies the read depth at the basepair before the breakpoint in EML4 or ALK.

Input: $$\\[0.1in]$$

file

The name of the file which the data are to be read from.

$$\\[0.1in]$$

reads

GAlignments returned by EML4_ALK_detection().

$$\\[0.1in]$$ genome

character representing the reference genome. 
Can either be "hg38" or "hg19". 
Default = "hg38".

$$\\[0.1in]$$

gene

Character string representing the gene. Can be either "ALK" or "EML4".

$$\\[0.1in]$$

Output:

If EML4-ALK is detected a single integer corresponding to the read depth at the breakpoint is returned. If no spanning reads in EML4 or ALK is detected an empty GAlignments object is returned. If no EML4-ALK is detected “No EML4-ALK was detected” is returned.

Examples:

break_position_depth(H3122_bam, H3122_result, genome = "hg38", gene = "EML4")
#> [1] 30
break_position_depth(HCC827_bam, HCC827_result, genome = "hg38", gene = "EML4")
#> [1] "No EML4-ALK was detected"

EML4_ALK_analysis()

This functions collects the results from the other functions of the package.

Input: $$\\[0.1in]$$

file

The name of the file which the data are to be read from.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can be either "hg38" or "hg19".
Default = "hg38".

$$\\[0.1in]$$

mates

integer, the minimum number EML4-ALK mate pairs needed to be detected in
order to call a variant. Default = 2.

$$\\[0.1in]$$

basepairs

integer, number of basepairs identified from the EML4-ALK fusion. 
Default = 20.

$$\\[0.1in]$$

Output:

A list object with clipped_reads corresponding to EML4_ALK_detection(), last_EML4 corresponding to EML4_sequence(), first_ALK corresponding to ALK_sequence(), breakpoint_ALK corresponding to break_position(), gene = “ALK”, breakpoint_EML4 corresponding to break_position(), gene = “EML4”, read_depth_ALK corresponding to break_position_depth().gene = “ALK”, and read_depth_EML4 corresponding to break_position_depth() gene = “EML4”. If no EML4-ALK is detected an empty GAlignments is returned.

Examples:

H3122_results <- EML4_ALK_analysis(file = H3122_bam, 
                                    genome = "hg38", 
                                    mates = 2, 
                                    basepairs = 20)
HCC827_results <- EML4_ALK_analysis(file = HCC827_bam, 
                                    genome = "hg38", 
                                    mates = 2, 
                                    basepairs = 20)

head(H3122_results$clipped_reads)
#> GAlignments object with 6 alignments and 2 metadata columns:
#>       seqnames strand       cigar    qwidth     start       end     width
#>          <Rle>  <Rle> <character> <integer> <integer> <integer> <integer>
#>   [1]     chr2      +       94M2S        96  42299657  42299750        94
#>   [2]     chr2      +       92M4S        96  42299659  42299750        92
#>   [3]     chr2      +       92M4S        96  42299659  42299750        92
#>   [4]     chr2      +       91M5S        96  42299660  42299750        91
#>   [5]     chr2      +       91M5S        96  42299660  42299750        91
#>   [6]     chr2      +       87M9S        96  42299664  42299750        87
#>           njunc |      mpos                     seq
#>       <integer> | <integer>          <DNAStringSet>
#>   [1]         0 |  29223479 TTGCTTCTTT...GCAGTGGTCT
#>   [2]         0 |  29223606 GCTTCTTTCA...AGTGGTCTGA
#>   [3]         0 |  29223573 GCTTCTTTCA...AGTGGTCTGA
#>   [4]         0 |  29223650 CTTCTTTCAC...GTGGTCTGAT
#>   [5]         0 |  29223601 CTTCTTTCAC...GTGGTCTGAT
#>   [6]         0 |  29223640 TTTCACTTAG...TCTGATTTTT
#>   -------
#>   seqinfo: 455 sequences from an unspecified genome

H3122_results$last_EML4
#> EML4_seq
#> CCAGGCTGGAGTGCAGTGGT GGAGTGCAGTGGTGTGATTT TCAGGCTGGAGTGCAGTGGT 
#>                   24                    1                    1

H3122_results$first_ALK
#> ALK_seq
#> AATGCAAAGCTAAAAATCAG ATGCAAAGCTAAAAATCAGA 
#>                    1                   36

H3122_results$breakpoint_ALK
#> break_pos
#> 29223740 29223741 
#>        1       36

H3122_results$breakpoint_EML4
#> break_pos
#> 42299750 42299757 
#>       25        1

H3122_results$read_depth_ALK
#> [1] 827

H3122_results$read_depth_EML4
#> [1] 30

HCC827_results
#> GAlignments object with 0 alignments and 0 metadata columns:
#>    seqnames strand       cigar    qwidth     start       end     width
#>       <Rle>  <Rle> <character> <integer> <integer> <integer> <integer>
#>        njunc
#>    <integer>
#>   -------
#>   seqinfo: no sequences

introns_ALK_EML4()

This function identifies the introns of ALK and EML4 where the breakpoint has happened.

Input: $$\\[0.1in]$$ file

The name of the file which the data are to be read from.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can be either "hg38" or "hg19".
Default = "hg38".

$$\\[0.1in]$$

Output:

Adataframeof the ALK- and EML4-intron of the breakpoint is returned corresponding to the transcript ENST00000389048.8 for ALK and ENST00000318522.10 for EML4. If the breakpoint is not located in introns of ALK or EML4, “Breakpoint not located in intron of ALK” or “Breakpoint not located in intron of EML4” is returned. If no EML4-ALK is detected “No EML4-ALK was detected” is returned.

Examples:

introns_ALK_EML4(file=H3122_bam,genome="hg38")
#>   intron_ALK intron_EML4
#> 1         19          13
introns_ALK_EML4(file=HCC827_bam,genome="hg38")
#> [1] "No ALK-EML4 was detected"

find_variants()

This function identifies the EML4-ALK variants as defined by Zhang et al. 2021

Input: $$\\[0.1in]$$ file

The name of the file which the data are to be read from.

$$\\[0.1in]$$

genome

character representing the reference genome. 
Can be either "hg38" or "hg19".
Default = "hg38".

$$\\[0.1in]$$

Output:

A dataframeof the EML4-ALK variant is returned. If no variant is detected, “No ALK-EML4 was detected” is returned. If the variant is not defined a list with identified introns with breakpoints is returned. If the breakpoint could not be identified in either of the genes a list with identified introns with breakpoints is returned.

Examples:

find_variants(file=H3122_bam,genome="hg38")
#>               Variant Intron_EML4 Intron_ALK
#> 1 Variant 1 (E13,A20)          13         19
find_variants(file=HCC827_bam,genome="hg38")
#> [1] "No ALK-EML4 was detected"