Data Processing Functions

BaMORC currently support file delimiters of comma, semicolon and whitespace. For users who want to run analysis on existing dataset from BMRB (NMR-STAR version 3), they can use either the read_NMRSTAR_file function with parameter of local file path or the readDBFile function with parameters of BMRB ID and flag that indicates whether data is assigned or unassigned. If readDBFile is used, BaMORC will utilize the BMRB web API to fetch the corresponding BMRB entry matching the ID.

read_db_file()

read_db_file() reads in data from existing database that included in the BaMORC package. This database was extracted from RefDB database.

read_nmrstar_file()

Extracts data from BMRB STAR 3.0 file. read_nmrstar_file() parses BMRB STAR 3.0 file. It will extract sequence information and chemical shifts for both alpha and beta carbons.

read_raw_file()

Extracts data from a protein NMR experimental peak list. read_raw_file() function reads in a user provided protein NMR experimental peak list. It currently supports file format in csv, txt with deliminator of comma, whitespace or semicolon. Note: please don't leave space between sequence and chemical shifts data, otherwise it will report error.

Calculation Functions

Funcations calculate necessary statsitical values that essential for BaMORC analysis.

calculate_aa_prob()

Calculates an amino acid typing probability.

calculate_chi_squared_stat()

Calculates a chi squared statistic(s).

calculate_mse()

Calculates mean squared error

calculate_rcf()

Calculates the relative cumulative frequency for amino acid and secondary structure.

BaMORC Analysis Functions

Fundamental core function for BaMORC analysis, which requires the secondary structure information.

bamorc()

Calculates the referencing correction value.

unassigned_bamorc()

Calculates the referencing correction value for unassigned protein NMR peaklists. unassigned_bamorc() will analyze unassigned protein NMR spectra, first groups the peaklist via SSC, then estimates the secondary structure via JPred, finally using BaMORC core function to calculate the reference correction value.

Utility Functions

Utility functions used by BaMORC analysis.

jpred_fetcher()

Using JPred Mass-submission scheduler program to submit protein sequence and return secondary structure results.

sample_data_generator()

sample_data_generator

Data Objects

AA57OLMatrix

Overlapping Matrix for 57 amino acid and secondary structure combinations.

AA57OLWeights

Overlapping weights for 57 amino acid and secondary structure combinations.

CAMuTable

Mean chemical shift values for alpha carbon .

CASdTable

Standard deviation of chemical shift values for alpha carbon .

CBMuTable

Mean chemical shift values for beta carbon .

CBSdTable

Standard deviation of chemical shift values for beta carbon .

AvgCov.t

Average covariance across three secondary structures for all amino acid typings (including oxidized cystine).

CarbonCov.t

Covariance values of chemical shifts of alpha and beta carbons.

RefDB.StatCA

Statistics of chemical shifts values of alpha carbons from RefDB.

RefDB.StatCB

Statistics of chemical shifts values of beta carbons from RefDB.

RefDB_data

RefDB object

inverseMatrices

inverseMatrices.

aaCodes1Letter19

Single-letter amino acid naming convention.

aaCodes1Letter20

Single-letter amino acid naming convention.

aaCodes3Letter1stCap

Three-letter amino acid naming convention with first letter capitalized.

aaCodes3LetterAllCap.v

Three-letter amino acid naming convention with all letters capitalized.

ID

RefDB ID included in the BaMORC package.

cname

All the amino acids and secondary structures combinations for easy access.

Built-in Samples

chemicalShifts

Pre-defined sample chemical shifts data.

aaFreq

Pre-defined amino acid frequency data.