Man pages for OlinkAnalyze
Facilitate Analysis of Proteomic Data from Olink

ansi_collapse_quotUtility function that adds quotation marks on elements...
assign_subject2plateassign subject to a plate for longitudinal randomization
check_checksumHelp function comparing the checksum reported by Olink...
check_col_keyCheck if col_key is valid.
check_columnsCheck presence of columns in dataset.
check_daridHelp function checking for DARID and PanelDataArchiveVersion...
check_file_existsHelp function checking if file exists.
check_file_extensionHelp function checking if file extension is acceptable.
check_ht_fixed_lod_versionHelp function to check Explore HT Fixed LOD file version
check_is_arrow_objectHelp function checking if a variable is an R6 ArrowObject.
check_is_booleanHelp function checking if a variable is a vector of booleans.
check_is_characterHelp function checking if a variable is a vector of...
check_is_datasetHelp function checking if a variable is a tibble or an...
check_is_integerHelp function checking if a variable is a vector of integers.
check_is_listHelp function checking if a variable is a list.
check_is_numericHelp function checking if a variable is a vector of numerics.
check_is_scalar_booleanHelp function checking if a variable is a scalar boolean.
check_is_scalar_characterHelp function checking if a variable is a scalar character.
check_is_scalar_integerHelp function checking if a variable is a scalar integer.
check_is_scalar_numericHelp function checking if a variable is a scalar numeric
check_is_tibbleHelp function checking if a variable is a tibble dataset.
check_library_installedHelp function to check if suggested libraries are installed...
check_log_colnameCheck if check_log has identified required column in the...
check_npxCheck NPX data format
check_npx_all_na_assaysHelp function to identify Olink assays with all quantified...
check_npx_all_na_sampleHelp function to identify Olink samples with all quantified...
check_npx_col_classHelp function checking types of columns in data.
check_npx_col_namesCheck, update and define column names used in downstream...
check_npx_duplicate_sample_idsHelp function checking for duplicate sample identifiers in...
check_npx_nonunique_uniprotHelp function checking for assays mapping to multiple UniProt...
check_npx_olinkidHelp function checking whether df contains invalid Olink...
check_npx_qcwarn_assaysHelp function checking data for assay QC warnings.
check_npx_update_col_namesUpdate column names to be used in downstream analyses
check_olink_broader_platformHelp function checking that broad_platform is expected.
check_olink_data_typeHelp function checking that data_type is expected.
check_olink_platformHelp function checking that olink_platform is expected.
check_olink_quant_typeHelp function checking that data_type is expected.
check_osiUtility function to check OSI values for validity
check_out_df_argHelp function checking that the requested output class of the...
clean_npxClean proteomics data quantified with Olink's PEA technology
convert_read_npx_outputHelp function converting the output dataset from read_npx*...
dot-check_paramsCommon parameters for check functions.
dot-downstream_fun_argsCommon parameters for downstream analysis functions.
dot-get_olink_data_detailsCommon parameters for getter functions in this file.
dot-read_npx_argsCommon parameters for read_npx-related functions.
generate_plate_holderCreate empty plate layout
get_all_olink_broader_platformsGet names of all broader Olink platforms.
get_all_olink_data_typesGet names of all Olink quantification methods (data types).
get_all_olink_platformsGet names of all Olink platforms.
get_all_olink_quant_typesGet names of all Olink quantification types.
get_alt_colnamesGets alternative column names for a given column key.
get_checksum_fileHelp function to get the file name of the checksum file from...
get_df_output_printPrints class type output from read_npx* functions.
get_field_separatorHelp function to get the separator of a delimited file...
get_file_extGets all file extensions based on the file format.
get_file_ext_summaryDescribes acceptable file extension for each file type.
get_file_formatsGet all acceptable file formats.
get_npx_fileHelp function to get the file name of the Olink data file...
get_olink_broader_platformsGet names of selected broader Olink platforms.
get_olink_data_typesGet names of selected Olink quantification methods (data...
get_olink_platformsGet names of selected Olink platforms.
get_olink_quant_typesGet names of selected Olink quantification types.
manifestExample Sample Manifest
mapping_file_idIdentifying which mapping file to use
norm_internal_adjustCombine reference and non-reference datasets
norm_internal_adjust_not_refAdd adjustment factors to a dataset
norm_internal_adjust_refModify the reference dataset to be combined with the...
norm_internal_assay_medianCompute median value of the quantification method for each...
norm_internal_bridgeInternal bridge normalization function
norm_internal_cross_productInternal function normalizing Olink Explore 3k to Olink...
norm_internal_reference_medianInternal reference median normalization function
norm_internal_rename_colsUpdate column names of non-reference dataset based on those...
norm_internal_subsetInternal subset normalization function
norm_internal_update_maxlodUpdate MaxLOD to the maximum MaxLOD across normalized...
npx_data1NPX Data in Long format.
npx_data2NPX Data in Long format, a follow-up.
olink_anovaFunction which performs an ANOVA per protein.
olink_anova_posthocFunction which performs an ANOVA posthoc test per protein.
olink_boxplotFunction which plots boxplots of selected variables
olink_bridgeability_plotPlots for each bridgeable assays between two products.
olink_bridge_selectorBridge selection function
olink_color_discreteOlink color scale for discrete ggplots
olink_color_gradientOlink color scale for continuous ggplots
olink_display_plate_distPlot distributions of a given variable for all plates
olink_display_plate_layoutPlot all plates colored by a variable
olink_dist_plotFunction to plot the NPX distribution by panel
olink_fill_discreteOlink fill scale for discrete ggplots
olink_fill_gradientOlink fill scale for continuous ggplots
olink_format_oid_no_overlapRetrieve non-overlapping assays between two NPX datasets
olink_format_rm_ext_ctrlRemove negative controls and plate controls from dataset. For...
olink_heatmap_plotFunction to plot a heatmap of the NPX data
olink_iqrCompute inter-quartile range (IQR) of multiplied by a fixed...
olink_lmerFunction that performs a linear mixed model per protein.
olink_lmer_plotFunction which performs a point-range plot per protein on a...
olink_lmer_posthocFunction which performs a linear mixed model posthoc per...
olink_lodCalculate LOD using Negative Controls or Fixed LOD
olink_medianCompute median of quantified value
olink_median_iqr_outlierCompute outliers based on median +/- iqr_sd * IQR
olink_normalizationNormalize two Olink datasets
olink_normalization_bridgeBridge normalization of all proteins between two NPX...
olink_normalization_bridgeableIdentify if assays shared between Olink Explore 3072 and...
olink_normalization_formatFormat the output of olink_normalization for seamless use...
olink_normalization_nBridge and/or subset normalization of all proteins among...
olink_normalization_n_checkAn internal function to perform checks on the input of the...
olink_normalization_project_name_checkAn internal function to perform checks on the input project...
olink_normalization_qsQuantile smoothing normalization of all proteins between two...
olink_normalization_sample_checkAn internal function to perform checks on the input samples...
olink_normalization_subsetSubset normalization of all proteins between two NPX...
olink_norm_input_assay_overlapCheck datasets and reference_medians for Olink identifiers...
olink_norm_input_checkCheck inputs of 'olink_normalization' function.
olink_norm_input_check_df_colsCheck columns of a list of datasets to be normalized.
olink_norm_input_check_samplesCheck reference samples to be used for normalization
olink_norm_input_classCheck classes of input in olink_normalization function
olink_norm_input_clean_assaysCheck datasets and reference_medians for unexpected Olink...
olink_norm_input_cross_productCheck if bridge or cross-platform normalization
olink_norm_input_norm_methodCheck datasets and reference_medians for Olink identifiers...
olink_norm_input_ref_mediansCheck datasets of reference_medians
olink_norm_input_validateValidate inputs of normalization function
olink_norm_product_idIdentify names of product for each project
olink_norm_reference_idIdentify reference project.
olink_one_non_parametricFunction which performs a Kruskal-Wallis Test or Friedman...
olink_one_non_parametric_posthocFunction which performs posthoc test per protein for the...
olink_ordinal_regressionFunction that performs a two-way ordinal analysis.
olink_ordinal_regression_posthocFunction which performs an posthoc test per protein.
olink_osi_dist_plotOSI distribution plot
olink_palOlink color panel for plotting
olink_pathway_enrichmentPerforms pathway enrichment using over-representation...
olink_pathway_heatmapCreates a heatmap of proteins related to pathways using...
olink_pathway_visualizationCreates bargraph of top/selected enrichment terms from GSEA...
olink_pca_plotFunction to plot a PCA of the data
olink_plate_randomizerRandomly assign samples to plates
olink_qc_plotFunction to plot an overview of a sample cohort per Panel.
olink_ttestFunction which performs a t-test per protein
olink_umap_plotFunction to make a UMAP plot from the data
olink_volcano_plotEasy volcano plot with Olink theme
olink_wilcoxFunction which performs a Mann-Whitney U Test per protein
product_to_platesizeCheck product name and set plate size accordingly
read_npxRead Olink data in R.
read_npx_delimHelp function to read long or wide format "Ct", "NPX", or...
read_npx_delim_longHelp function to read long format "Ct", "NPX", or...
read_npx_delim_wideHelp function to read wide format "Ct", "NPX", or...
read_npx_excelHelp function to read long or wide format "Ct", "NPX", or...
read_npx_formatHelp function to read excel and delimited Olink data files in...
read_npx_format_colnamesHelp function checking whether a dataset contains NA or empty...
read_npx_format_get_formatHelp function to determine the format (wide or long) of the...
read_npx_format_get_platformHelp function to determine the Olink platform from the input...
read_npx_format_get_quantHelp function to determine the type of quantification from...
read_npx_format_readHelp function to read excel and delimited Olink data files in...
read_npx_legacyOlink legacy function for reading NPX or absolute...
read_npx_legacy_checkHelp function ensuring 'read_npx_legacy' works
read_npx_legacy_helpHelp function utilizing functions from 'read_npx_format' and...
read_npx_parquetHelp function to read NPX data from long format parquet Olink...
read_npx_wideConvert Olink data in wide format with "Ct", "NPX", and...
read_npx_wide_bottomConvert the bottom matrix from Olink dataset in wide format...
read_npx_wide_bottom_versionAdditional checks of the bottom matrix of Olink dataset in...
read_npx_wide_check_topAdditional checks of the top matrix of Olink dataset in wide...
read_npx_wide_middleSplit the middle matrix from Olink dataset in wide format.
read_npx_wide_npxs_versionExtract version of NPX Signature from the head matrix of...
read_npx_wide_panel_versionHelp function to extract Panel_Version from Panel column.
read_npx_wide_split_rowSplit Olink wide files to sub-matrices.
read_npx_wide_topSplit the top matrix from Olink dataset in wide format.
read_npx_zipHelp function to read "Ct", "NPX", and "Quantified" data from...
red_npx_wide_top_mid_longCombine top and middle matrices in long format.
remove_all_na_colsUtility function removing columns with all values NA from a...
run_check_npxCheck and run 'check_npx()' if not provided.
set_plot_themeFunction to set plot theme
OlinkAnalyze documentation built on June 24, 2026, 1:06 a.m.