Get trait-specific summary table from a ColocBoost output.
Source:R/colocboost_output.R
get_ucos_summary.Rd
get_ucos_summary
produces a trait-specific summary table for uncolocalized (single-trait)
associations from ColocBoost results. This is particularly useful for examining trait-specific signals
or for summarizing results from single-trait FineBoost analyses.
Usage
get_ucos_summary(
cb_output,
outcome_names = NULL,
region_name = NULL,
ambiguous_cos = FALSE,
min_abs_corr_between_ucos = 0.5,
median_abs_corr_between_ucos = 0.8
)
Source
See detailed instructions in our tutorial portal: https://statfungen.github.io/colocboost/articles/Interpret_ColocBoost_Output.html
Arguments
- cb_output
Output object from
colocboost
analysis- outcome_names
Optional vector of names of outcomes, which has the same order as Y in the original analysis.
- region_name
Optional character string. When provided, adds a column with this gene name to the output table for easier filtering in downstream analyses.
- ambiguous_cos
Logical indicating whether to include ambiguous colocalization events. The default is FALSE.
- min_abs_corr_between_ucos
Minimum absolute correlation for variants across two trait-specific (uncolocalized) effects to be considered colocalized. The default is 0.5.
- median_abs_corr_between_ucos
Median absolute correlation for variants across two trait-specific (uncolocalized) effects to be considered colocalized. The default is 0.8.
Value
A list containing:
ucos_summary
: A summary table for trait-specific, uncolocalized associations with the following columns:outcomes
: Outcome being analyzeducos_id
: Unique identifier for trait-specific confidence setspurity
: Minimum absolute correlation of variables within trait-specific confidence setstop_variable
: The variable with highest variant-level probability of association (VPA)top_variable_vpa
: Variant-level probability of association (VPA) for the top variableucos_npc
: Normalized probability of causal association for the trait-specific confidence setn_variables
: Number of variables in trait-specific confidence setucos_index
: Indices of variables in the trait-specific confidence setucos_variables
: List of variables in the trait-specific confidence setucos_variables_vpa
: Variant-level probability of association (VPA) for all variables in the confidence setregion_name
: Region name if provided through the region_name parameter
ambiguous_cos_summary
: A summary table for ambiguous colocalization events with the following columns:outcomes
: Outcome in the ambiguous colocalization eventucos_id
: Unique identifiers for the ambiguous eventmin_between_purity
: Minimum absolute correlation between variables across trait-specific sets in the ambiguous eventmedian_between_purity
: Median absolute correlation between variables across trait-specific sets in the ambiguous eventoverlap_idx
: Indices of variables that overlap between ambiguous trait-specific setsoverlap_variables
: Names of variables that overlap between ambiguous trait-specific setsn_recalibrated_variables
: Number of variables in the recalibrated colocalization set from an ambiguous eventrecalibrated_index
: Indices of variables in the recalibrated colocalization set from an ambiguous eventrecalibrated_variables
: Names of variables in the recalibrated colocalization set from an ambiguous eventrecalibrated_variables_vcp
: Variant colocalization probabilities for recalibrated variables from an ambiguous eventregion_name
: Region name if provided through the region_name parameter
See also
Other colocboost_utilities:
get_cormat()
,
get_cos()
,
get_cos_purity()
,
get_cos_summary()
,
get_hierarchical_clusters()
Examples
# colocboost example with single trait analysis
set.seed(1)
N <- 1000
P <- 100
# Generate X with LD structure
sigma <- 0.9^abs(outer(1:P, 1:P, "-"))
X <- MASS::mvrnorm(N, rep(0, P), sigma)
colnames(X) <- paste0("SNP", 1:P)
L <- 1 # Only one trait for single-trait analysis
true_beta <- matrix(0, P, L)
true_beta[10, 1] <- 0.5 # SNP10 affects the trait
true_beta[80, 1] <- 0.2 # SNP11 also affects the trait but with lower effect
Y <- X %*% true_beta + rnorm(N, 0, 1)
res <- colocboost(X = X, Y = Y, output_level = 2)
#> Validating input data.
#> Starting gradient boosting algorithm.
#> Gradient boosting for outcome 1 converged after 60 iterations!
#> Performing inference on colocalization events.
# Get the trait-specifc effect summary
get_ucos_summary(res)
#> outcomes ucos_id purity top_variable top_variable_vpa n_variables
#> 1 Y1 ucos1:y1 0.9047605 SNP10 0.9250798 2
#> ucos_index ucos_variables ucos_variables_vpa
#> 1 10; 9 SNP10; SNP9 0.925079798036013; 0.0745019602528287