shazam (version 0.1.9)

calcExpectedMutations: Calculate expected mutation frequencies of a sequence

Description

calcExpectedMutations calculates the expected mutation frequencies of a given sequence. This is primarily a helper function for expectedMutations.

Usage

calcExpectedMutations(germlineSeq, inputSeq = NULL, targetingModel = HH_S5F,
  regionDefinition = NULL, mutationDefinition = NULL)

Arguments

germlineSeq

germline (reference) sequence.

inputSeq

input (observed) sequence. If this is not NULL, then germlineSeq will be processed to be the same same length as inputSeq and positions in germlineSeq corresponding to positions with Ns in inputSeq will also be assigned an N.

targetingModel

TargetingModel object. Default is HH_S5F.

regionDefinition

RegionDefinition object defining the regions and boundaries of the Ig sequences.

mutationDefinition

MutationDefinition object defining replacement and silent mutation criteria. If NULL then replacement and silent are determined by exact amino acid identity.

Value

A numeric vector of the expected frequencies of mutations in the regions in the regionDefinition. For example, when using the default IMGT_V definition, which defines positions for CDR and FWR, the following columns are calculated:

• MU_EXPECTED_CDR_R: number of replacement mutations in CDR1 and CDR2 of the V-segment.

• MU_EXPECTED_CDR_S: number of silent mutations in CDR1 and CDR2 of the V-segment.

• MU_EXPECTED_FWR_R: number of replacement mutations in FWR1, FWR2 and FWR3 of the V-segment.

• MU_EXPECTED_FWR_S: number of silent mutations in FWR1, FWR2 and FWR3 of the V-segment.

Details

calcExpectedMutations calculates the expected mutation frequencies of a given sequence and its germline.

Note, only the part of the sequences defined in regionDefinition are analyzed. For example, when using the default IMGT_V definition, mutations in positions beyond 312 will be ignored.

See Also

expectedMutations calls this function. To create a custom targetingModel see createTargetingModel. See calcObservedMutations for getting observed mutation counts.

Examples

# NOT RUN {
# Load example data
data(ExampleDb, package="alakazam")

# Use first entry in the exampled data for input and germline sequence
in_seq <- ExampleDb[["SEQUENCE_IMGT"]][1]
germ_seq <-  ExampleDb[["GERMLINE_IMGT_D_MASK"]][1]

# Identify all mutations in the sequence
calcExpectedMutations(in_seq, germ_seq)

# Identify only mutations the V segment minus CDR3
calcExpectedMutations(in_seq, germ_seq, regionDefinition=IMGT_V)

# Define mutations based on hydropathy
calcExpectedMutations(in_seq, germ_seq, regionDefinition=IMGT_V,
                      mutationDefinition=HYDROPATHY_MUTATIONS)

# }