Man pages for ftwkoopmans/msdap
Mass Spectrometry Downstream Analysis Pipeline

add_contrastCreate a contrast for differential expression analysis
add_protein_prettyprint_labeladd short prettyprint labels to a protein tibble using gene...
adjust_modesscale sample k by scaling factor s_k ->> don't have to...
aggregate_tibble_by_datatableshighly optimized aggregation of the peptides data table....
analysis_quickstartQuickstart for analyses in this pipeline
append_logThis function is called throughout the pipeline to append...
append_log_errorAppend error object to log
append_log_timestampAppend text to the log file and print to console, including a...
as_matrix_except_first_columnconvert a wide-format data.frame to a matrix
assert_lme4_functionalThrow an error if lme4::lmer() cannot be executed
boxplot_add_textplaceholder title
cache_filtering_dataCache data required for fast downstream peptide filtering
check_dataset_hascachecheck if peptide tibble has cache
check_dataset_integrityTest if the minimum set of required information is present in...
check_parameter_is_booleangeneric input validation; all provided arguments should be...
check_parameter_is_numericgeneric input validation; all provided arguments should be...
check_parameter_is_stringgeneric input validation; all provided arguments should be...
check_valid_tibble_peptidesdata integrity checks for peptide tibble
check_valid_tibble_proteinsdata integrity checks for protein tibble
check_valid_tibble_samplesdata integrity checks for sample tibble
coefficient_of_variationCoV computation for an array of non-log values
coefficient_of_variation_vectorizedfast CoV computation for all rows in a matrix of natural-log...
column_intensity_to_labelpretty-print label for an intensity column
contrast_to_samplegroupsreturn sample groups for a given contrast (column name in...
count_sep_charCount how often commonly used separation characters occur in...
dataset_filter_customCustom dataset filtering rules that also enable one-sided...
dataset_transfer_peptide_propertiescarries over protein_id, sequence_plain and sequence_modified...
deaDifferential expression analysis
dea_algorithmsreturns all DEA functions integrated with MS-DAP
dea_algorithms_reservedreserved DEA function names
dea_protein_background_foldchange_limitsestimate a threshold for 'significant' foldchanges from N...
dea_results_to_wideconvert the results from differential expression analysis...
dea_summary_prettyprintprettyprint table that summarizes DEA results
de_deqmsApply DEqMS to a protein-level ExpressionSet
de_ebayesApply limma::eBayes() function to a protein-level...
de_msempireMS-EmpiRe implementation, a wrapper function for...
de_msqrob_customformulaMSqRob test function for internal use
de_msqrobsum_msqrobWrapper function for msqrob, using the implementation from...
diffdetect_results_to_wideconvert the results from differential detection analysis from...
diffdetect_summary_prettyprintprettyprint table that summarizes differential detect results
differential_detectCompare the number of peptide detection counts between groups
differential_detection_filterProtein differential detection filtering using a hardcoded...
disambiguate_protein_table_by_genegiven some table with protein-level data, map to HGNC genes...
empty_protein_tibbleplaceholder long-format proteins tibble with minimum set of...
enforce_sample_value_typesconvert the data type of column in a sample metadata table to...
error_legacy_contrast_definitionsthrow an error if has_legacy_contrast_definitions() is TRUE
export_peptide_abundance_matrixExport peptide-level data to TSV files
export_protein_abundance_matrixRollup and export to protein-level TSV table, applied to all...
export_statistical_resultswrite statistical results to file
export_stats_genesummaryCreate gene-level summary tables for your DEA and...
fasta_header_to_geneextract gene symbol from fasta header string
fasta_header_to_idextract the protein identifier from a fasta header
fasta_identifier_isdecoyregex test if a protein identifier or fasta header is a decoy
fasta_id_shortextract the "short ID" from a fasta header.
fasta_parse_fileRead non-redundant headers from all fasta files
file_checkstrip illegal characters from filename, then check for...
filename_extract_extensionextract the trailing file extension from a file or path
filename_strip_illegal_charactersfrom filename minus extension, replace illegal characters...
filter_datasetFilter dataset
fit_t_dist_fixed_muuse optim() to fit a t-distribution with fixed mu=0
format_r_codeformat a string of R code using the formatR and styler...
fragpipe_find_psm_filesHelper function to find psm.tsv files within a FragPipe...
fragpipe_map_combined_proteinRead FragPipe combined_protein.tsv table and then update all...
fragpipe_modification_to_instruction__legacyTHIS FUNCTION SHOULD ONLY BE USED FOR LEGACY FRAGPIPE...
fragpipe_modseq_composeReconstruct modified peptide sequences from disjoint...
fragpipe_parse_msstatsParse a FragPipe MSstats.csv table
fragpipe_parse_psmParse a FragPipe psm.tsv table
fragpipe_parse_quantParse a FragPipe quant.csv table
fragpipe_peptideresults_to_datasetFrom FragPipe peptide result table to an MS-DAP dataset
generate_pdf_reportCreate the Quality Control report
get_column_intensityprioritized selection of intensity column in a peptides...
get_modefind the mode in a numeric array using the density function...
get_peptide_filternorm_variantsReturn column names in peptide table that hold intensity...
get_protein_matrixrollup peptides to protein data matrix for selected intensity...
get_samples_for_regressioncollect the respective subset of samples for selected protein...
gg_color_huegenerate colours analogous to ggplot's default palette
ggplot_coefficient_of_variationplaceholder title
ggplot_coefficient_of_variation__leave_one_outplaceholder title
ggplot_peptide_abundancesplot peptide-level data for a single protein
ggplot_peptide_detect_frequencyplaceholder title
ggplot_peptide_detect_frequency_distributionplaceholder title
ggplot_sample_detect_counts_barplotsplaceholder title
ggplot_sample_detect_vs_metadata_scatterplotcompact scatterplot with color-coding captures all sample...
ggplot_sample_detect_vs_metadata_scatterplot_by_propseparate plot for each metadata property
ggplot_split_legendsplit a ggplot object into 2 ggplots; original plot minus...
has_legacy_contrast_definitionstest if the dataset has contrast definitions that are...
hgnc_add_xrefsadd hgnc_symbol and entrez/ensembl IDs if present in hgnc...
hgnc_lookuptableParse HGNC gene identifier lookup table that was downloaded...
idmap_symbolshelper function to match a protein table to HGNC via gene...
idmap_uniprotidhelper function to match a protein table to HGNC via an...
import_dataset_diannImport a label-free proteomics dataset from DIA-NN
import_dataset_encyclopediaImport a label-free proteomics dataset from EncyclopeDIA
import_dataset_fragpipe_ionquantImport a label-free proteomics dataset from FragPipe;...
import_dataset_fragpipe_ionquant__legacyTHIS FUNCTION SHOULD ONLY BE USED FOR LEGACY FRAGPIPE...
import_dataset_fragpipe_psm_fileAlternative FragPipe workflow, operates directly on a single...
import_dataset_in_long_formatFor advanced users: A generic function for importing data in...
import_dataset_maxquant_evidencetxtImport a label-free proteomics dataset from MaxQuant
import_dataset_metamorpheusImport a label-free proteomics dataset from MetaMorpheus
import_dataset_openms_mztabImport a label-free DDA proteomics dataset from OpenMS,...
import_dataset_openswathImport a label-free proteomics dataset from OpenSWATH
import_dataset_peaksImport a label-free proteomics dataset from Peaks
import_dataset_proteomediscoverer_txtImport a label-free DDA proteomics dataset from a...
import_dataset_skylineImport a label-free proteomics dataset from Skyline
import_dataset_spectronautImport a label-free proteomics dataset from Spectronaut
import_expressionsetImport a label-free proteomics dataset from a peptide-level...
import_fastaImport fasta file(s) that match your dataset.
import_maxquant_peptidesImport a label-free proteomics dataset from MaxQuant, using...
import_maxquant_proteingroupsImport peptide-to-protein mappings from MaxQuant
import_metamorpheus_proteingroupsplaceholder title
import_metamorpheus_quantifiedpeaksplaceholder title
import_protein_metadata_from_fastaParse fasta files and construct a protein metadata table for...
import_sample_metadataImport sample metadata from an Excel table
initialize_multiprocessingTo facilitate multiprocessing, create a Parallel Socket...
invalidate_cacheinvalidate peptide tibble cache
is_dia_datasetTest if the dataset contains DIA data, simply testing if the...
limma_fit_extract_statsextract limma fit results
limma_wrapperPerform linear regression with limma
log2_to_lnconvert base-log from log2 to natural log
logger.defaultLog function that takes any string, appends it to global log...
log_peptide_tibble_pep_prot_countsreport number of detected precursor and plainseq, target and...
make_binsbin an array and return both the bins and their metadata...
map_headersrobust matching of a list of desired columns to a character...
matrix_grouped_column_aggregatefast grouped matrix aggregation using data.table
matrix_to_longwrapper function around tidyverse's gather to convert a...
merge_fractionated_samplesmerge fractionated samples
merge_proteingroups_by_geneMerge protein identifiers that map to the same unique set of...
merge_replicate_samplesMerge technical replicates prior to downstream analysis
metadata_matrix_from_filenamesGuess experiment data from a set of filenames
mgi_lookuptableParse MGI ID mapping table table into a lookup table with...
minlog10Accept pvalues that are exactly zero as the 'best pvalue'
msdap-packageMS-DAP: Mass Spectrometry Downstream Analysis Pipeline for...
msdap_versionreturn msdap package version as a string
normalization_algorithmsreturns all normalization algorithms integrated with MS-DAP
normalize_matrixNormalize a numeric matrix; in MS-DAP this is typically a...
normalize_medianscale each sample such that median abundance values are the...
normalize_modebetween_proteinGiven some peptide-level matrix, normalize samples using...
normalize_msempirewrapper function for msEmpiRe::normalize()
normalize_peptide_intensity_columnApply an array of normalization algorithms to some intensity...
normalize_rlrWrapper function for normalize_rlr_MSqRob_implementation
normalize_rlr_MSqRob_implementationRobust Linear Regression (RLR) normalization as sourced from...
normalize_vwmbNormalize a numerical matrix by the Variation Within, Mode...
norm_scales_fcmodeminimize the foldchange-mode between all columns
norm_scales_varminimize variation over all rows in a numeric matrix
pairwise_modescompute the mode of all sample/column pairs column pairs that...
parse_fragpipe_proteins_from_combined_proteinsConstruct MS-DAP style protein group identifiers from a...
parse_fragpipe_proteins__legacyTHIS FUNCTION SHOULD ONLY BE USED FOR LEGACY FRAGPIPE...
path_append_and_checkappend file to path, then call file_check() for validation of...
path_clean_slashesregex replace back slashes and redundant forward/back-slashes...
path_existsCombine path and filename, then check if filename exists....
pdf_combine_chunkscombine PDF files
peptide_and_protein_counts_per_sampleadd peptide and protein counts to samples tibble, so...
peptides_collapse_by_sequenceplaceholder title
permute_abbasic between-group permutation implementation
plot_abundance_distributionsplaceholder title
plot_benchmark_volcanoplaceholder title pre-define color_code and minlog10pval
plot_dia_cscore_histogramsplaceholder title
plot_differential_detectPlot differential detection results as a histogram
plot_foldchange_distribution_among_replicatesPlot within-group foldchange distributions to assess outlier...
plot_foldchangesplaceholder title
plot_peptide_dataplot peptide-level data
plot_peptide_data_by_contrast_to_pdfplot peptide-level data
plot_pvalue_histogramplaceholder title
plot_retention_time_v2placeholder title
plot_rocplaceholder title prior to this; species %in% c("YEAST",...
plot_sample_pcaplaceholder title for reference, standard pca (does not cope...
plot_sample_pca__sample_in_contrasthelper function for use-case beyond making a report using...
plot_true_false_positive_countsplaceholder title
plot_variance_explainedPlot the variance explained of sample metadata properties in...
plot_volcanovolcano plot for DEA results, split into 4 panels;...
plot_volcano_allcontrasta simple wrapper around plot_volcano() that iterates all...
print_available_filtering_resultsReturn column names in peptide table that hold intensity...
print_contrastsPrint an overview of all defined contrasts and their...
print_dataset_summaryPrint a short summary of a dataset to console
protein_eset_from_dataprotein-level ExpressionSet from protein abundance matrix
proteingroup_to_idshort_lookuptablelookup table for proteingroup identifiers (in long or short...
read_table_by_header_specEfficiently read a table based on some specification of...
read_textfile_compressedRead text files as vector of lines or a table, supports...
reduce_ggplot_object_sizeReduce the memory footprint of ggplot objects
reformat_dateRecognize dates formatted as 8 consecutive integers and...
regex_classificationClassify an array of strings by regular expression
regex_rawfile_strip_extensionreturns a regex string that can be used to remove extensions...
remove_by_charlengthremove NA, non-character and characters shorter than N from...
remove_contrastsRemove all contrast definitions and respective filtering and...
remove_file_extension_from_pathremove a single file extension from a path or filename
remove_file_if_existsremove file if exists
remove_proteins_by_nameCompletely remove proteins, and all their peptides, that...
replace_inf_with_NAfast replacement in a data.frame; infinite values to NA...
replace_nonfinitefast replacement in a vector; nonfinite to target value
replace_zero_with_NAfast replacement in a data.frame; zero values to NA...
reset_logclear the log by resetting global log_ variable
rgd_lookuptableParse RGD ID mapping table table into a lookup table with...
rmarkdown_xtable_customplaceholder title https://stackoverflow.com/a/16580525
robust_header_matchingrobust matching of column names to a data.frame, returns the...
rollup_pep2protwrapper function for peptide-to-protein rollup
rollup_pep2prot_maxlfqrollup by MaxLFQ algorithm
rollup_pep2prot_summationrollup a peptide tibble by summation of all intensity values...
rollup_pep2prot_tmprollup a peptide tibble by applying Tukey's median polish...
sample_color_codinggenerate color-coding for all sample metadata
sample_color_coding__long_formatgenerate color-codings for all sample metadata
sample_metadata_customFor advanced users: import sample metadata directly from the...
sample_metadata_from_fileread sample metadata table from file and match it against...
sample_metadata_from_filenamesextract metadata from sample names using regular expressions
sample_metadata_sort_and_filtersample metadata formatting and validation
scale_between_quantilesscale an array of numerics between 0~1, thresholding values...
score_classification_countsscore which classification works best when e.g. guesstimating...
setup_contrastsSetup contrasts for downstream Differential Expression...
shift_emptytry to align matrix columns eg; inconsistent use of...
smooth_loess_customLoess fit on finite value pairs. Ignores overfit warnings,...
split_alt_sep_chardetect case of forgotten separation character, alternative...
split_arraysplit array into a list of N-sized chunks
split_char_numdetect case of forgotten separation character
split_genericgeneric detection of metadata splitting
split_recursivelyrecursively split within all columns of a matrix
strip_common_substringremove starting or trailing substrings that ar the same for...
subchunkifyplaceholder title https://github.com/yihui/knitr/issues/1494...
subset_protein_eset_for_deahelper function to double-check we don't submit an...
subset_relevant_code_snippet_for_reportsubset lines of R code (provided as strings) from the last...
summarise_statsSummarize DEA and/or differential detection results in a...
summarise_stats__for_contrastworker function for actual stats summary
threshold_numericsthreshold finite numeric values
tibble_as_esetpeptide-level ExpressionSet from long-format peptide data
tibble_peptides_reorderrearrange column in a long-format peptides tibble
update_protein_mappingFor advanced users: update a peptide tibble with new...
update_protein_mapping_from_maxquantUpdate the peptide-to-protein mappings using a MaxQuant...
user_provided_metadataGet column names that represent sample metadata provided by...
validate_eset_fitdataInput validation for eBayes/DEqMS/MS-EmpiRe functions
write_template_for_sample_metadataWrite an Excel sheet to file that contains all samples in the...
ftwkoopmans/msdap documentation built on March 5, 2025, 12:15 a.m.