Learn R Programming

HDXBoxeR

HDXBoxeR is a tool designed to streamline various aspects of HDX (Hydrogen-Deuterium Exchange) data analysis:

  1. Data Reprocessing: Reprocesses data to the format required for data publication.
  2. Parameter Calculation: Calculates parameters for a general HDX summary table, including backexchange, peptide lengths, and statistical information.
  3. Output Conversion: Converts output from HDXExaminer (formerly Sierra Analytics, now Trajan Scientific) to a more manageable and analyzable format.
  4. Statistical Analysis: Identifies peptides significantly different between sets using Welch T-tests.
  5. Script Generation: Generates scripts for Pymol visualization.
  6. Plot Generation: Facilitates easy plot generation, including heat maps, robot plots (modified butterfly plots), significant peptides, volcano plots, and average deuteration.
  7. ExtReme Inputs: Generates inputs for ExtReme, enabling comparison between different protein states and discrimination of significantly different peptides.

Usage

HDXBoxeR can be used to enhance the efficiency and effectiveness of HDX data analysis, providing tools for data processing, analysis, and visualization.

Installation & Loading

First, ensure that you have R (and RStudio) installed on your computer. Then you can proceed with the installation of the HDXBoxeR package. There are two methods to install the HDXBoxeR package:

  1. CRAN

To install, use the following command:

install.packages("HDXBoxeR") #execute only once

  1. GitHub

The HDXBoxeR package is available on GitHub and can be installed using the devtools package. This method of installation is an alternative to the CRAN method.

install.packages("devtools") #if not installed

library(devtools) #run next two commends only once

devtools::install_github("mkajano/HDXBoxeR")

Loading

After installing HDXBoxeR in R, load the package using following command:

library(HDXBoxeR)

vignette and examples

Please access the vignette with examples at:

https://cran.r-project.org/web//packages/HDXBoxeR/vignettes/HDXBoxeR.html

test data location:

After HDXBoxeR package installation the test data will be located in system files of the HDXBoxeR. The path to the input table is shown below:

file_nm<-system.file("extdata", "All_results_table.csv", package = "HDXBoxeR")

License

This project is licensed under the GPL (>= 2) licence

Copy Link

Version

Install

install.packages('HDXBoxeR')

Monthly Downloads

155

Version

0.0.2

License

GPL (>= 2)

Maintainer

Maria K. Janowska

Last Published

August 24th, 2024

Functions in HDXBoxeR (0.0.2)

getCoords1

function from plotfunctions package
duplicate_sets

Duplicate set function
extreme_input_undeut

Makes input for Extreme for bimodal analysis.
general_info

Provides summary table for all data.sets.
lab_dif_proc

Preparatory function for difference plot for procent deuteration
is.nan.data.frame

Checks for NaN is data.frame
heat_map_tc

Plots heat maps for time courses.
legend_nm_bottom

Legend, bottom of the plots
legend_heat_map_tp_proc

Legend for the heatmaps percent.Extracts names from data.frame
lab_dif

Legend for difference in averages plot.
heat_map_tp_maxuptake_proc

Preparatory function for heat map of maximum procent deuteration per residue.
legend_heat_map_tp

Legend for the heatmaps.Extracts names from data.frame
average_timecourse

Calculates average for time course data.
extreme_input_gap

Makes input for Extreme for bimodal analysis.
heat_map_tp

Preparatory function for heat map
deuteration_woods_timepoints

Return woods plots for the timepoints
nb_exch_deut

Number of exchangeable protons
legend_heat_map_timecourse

Legend for the heatmaps prep function for timecourses.
dif_ave

Returns data frame with difference of averages between State1 and other states provided.
ave_timepoint

Returns average value for either uptake of procent data.
heat_map_tp_proc

Preparatory function for heat map for procent deuteration
nm_states

Lists names of states in data sets
pl_gen_uptake

Prepares the plot window for the woods functions
output_tp

Prepares output for HDX-MS for the deuteration uptake or percent deuteration for the time points.
plot_heat_map_max_uptake_tp_proc

Plots heat maps for maximum procent deuteration per residue.
pallette_legend

Color scheme using heatmap. Legend Extracts names from data.frame
coverage_residue

Returns coverage per residue
heat_map_tp_maxuptake

Preparatory function for heat map of maximum uptake per residue.
output_prep

Prepares output with HDX-MS data for publications
legend_raw_ave_tc

Legend for average deuteration plot for timecourse.
lab_vol

Preparatory function for volcano plot legends
legend_sig_peptides

Legend for the significant peptides
plot_heat_map_max_uptake_tp

Plots heat maps for maximum uptake per residue.
pymol_script_average_residue

Writes a text files with pymol scripts to list significant residues.
pymol_script_significant_peptide

Writes a text files with pymol scripts to list significant peptides
legend_raw_ave_proc

Preparatory function to draw legends for average procent
legend_raw_ave

Legend for average plot.
output_FD

Prepares output for HDX-MS Full deuteration data
output_tc

Prepares output for HDX-MS for the deuteration uptake or percent deuteration for the time courses.
plot_heat_map_tp

Plots heat maps for significant peptides.
plots_av_tp_proc

Returns average procent deuteration plot for time points
plot_heat_map_tp_proc

Plots heat maps for significant peptides.
qpcr.cbind.na

Hidden function from qpcR package, typical usage as qpcR:::cbind.na
output_FD_proc

Prepares output for HDX-MS Full deuteration data for procent deuteration.
ranges_function

Gives ranges for the averages
plots_av_tcourse

Generates average deuteration plot for the time-course.
plots_av_tp

Returns average deuteration plot for timepoints in the data frame
plots_diff_tp

Returns difference in average plot for timepoints in the data frame
summary_sd_CI

Provides summary table with Critical interval and standard deviation within the set.
uptake_plots

Uptake plots
dif_tp

Preparatory function for difference plot
deuteration_woods_timecourse

Return woods plots for the timecourse
pymol_script_significant_residue

Writes a text files with pymol scripts to list significant residues.
pymol_script_significant_peptide_proc

Writes a text files with pymol scripts to list significant peptides
ranges_function_tc

Gives ranges for the averages for time course analysis
legend_heat_map

Legend for the heatmaps prep function.
legend_heat_map_tc

Legend for the heatmaps for timecourses.
dif_tp_proc

Preparatory function for difference plot
plot_heat_map_tc

Plots heat maps for time courses.
legend_tc_bottom

Preparatory function returns legends for the timecourses.
peptide_pv_tp_proc

Preparatory function for showing peptides with significant differences between sets.
plots_diff_tp_proc

Returns difference in average procent deuteration plot for timepoints in the data frame
ppar_bottom_legend

Preparation of figure window with area for figure at the bottom.
legend_states_PerD_bottom

Legend, bottom of the plots
plots_vol_tp

Returns volcano plots for timepoints in the data frame
pl_gen_ch2

Prepares the plot window for the woods functions
rbind_na

bind non equal row
select_indices

Allows for selecting some peptide from input data
reset_par

Reset plotting window parameters to default
significant_peptide_uptake

Function returns which peptides are significantly based of pv_cutoff and Critial interval
verbose_timepoint_output

Returns csv with averages from analysis for uptake file, standard deviation, p-values.
robot_2states_indexes

Returns a robot plot for selected peptides for 2 protein states.
ppar_wider

Preparation of figure window with more area on west side of plot.
verbose_timecourse_output

Returns csv with averages from analysis for procent deuteration file, standard deviation for time courses.
plot_peptide_sig_tp_proc

Draws peptides with significant difefrences between sets.
plot_peptide_sig_tp

Significant peptide plots.
prep_timecourse_plot_sd

Prepares function for Critical interval for timecourses
prep_timecourse_plot_ave

Prepares function for plotting averages in timecourse
pymol_str

Preparatory function writing pymol scripts
pymol_script_significant_residue_proc

Writes a text files with pymol scripts to list significant residues.
sd_timecourse_proc

Returns standard deviation for percent deuteration data for timecourses.
output_UD

Prepares output for HDX-MS Undeuterated sample data.
peptide_pv_tp

Preparatory function for significant peptide plots
pallette_ll

Color scheme using heatmap. Legend extracts names from data frame
output_UD_proc

Prepares output for HDX-MS Undeuterated data for procent deuteration.
vol_tp

Preparatory function for volcano plot
woods_CI_plot

Returns a woods plot for comparisons of the timepoints samples
sd_timepoint

Returns standard deviation for dataframe.
ppar

Preparation of figure window.
pv_timepoint

Calculation of pvalue between first protein state and any other state from all_states file
pparLM

Preparation of figure window. small margins
robot_indexes_df

Returns dataframe with peptides which exhibit significant difference between two sets
robot_plot_All

Returns a robot plot for comparisons of the timepoints samples
pv_timecourse

pvalue calculation between two sets of the data at certain timepoint
robot_indexes

Returns indexes for peptides with significant difference between two sets
sd_timecourse

Returns standard deviation for uptake data for timecourses.
arg_UN_FD

Returns initially processed data.frame from the export from the HDXExaminer
arguments_call2

Returns default arguments for the output_tp functions. Deut.Time
CI_single

Global confidence interval treshold from experimental standard deviation for 1 sample
CI_tp

Global confidence interval treshold from experimental standard deviation
CI_tc

Critial interval calculation two sets of timecourses
all_summary

Returns full summary table.
arguments_call1

Returns default arguments for the output_tp functions. States
CI_2pts

Global confidence interval treshold from experimental standard deviation for 2 samples.
arguments_call3

Returns default arguments for the output_tp functions. # replicates
arg_df

Returns initially processed data.frame from the export from the HDXExaminer
av_tc

Preparatory function for average plot for timecourses
color_ranges_Blue_Red_heat_map

Returns color pallete from red to blue with number of colors for defined ranges
color_ranges_Spectral

Returns Spectral pallette with colors matching defined ranges
av_tp

Preparatory function for average plot
backHX_calculations

Summary of backexchange summary
boxplot_tp

Plots boxplots for all the averages in the set