SUSIE | R Documentation |
Sum of Single Effects (SuSiE): Iterative Bayesian Step-wise Selection.
SUSIE( dat, LD_matrix, case_control = TRUE, max_causal = 5, compute_n = "ldsc", priors_col = NULL, rescale_priors = TRUE, credset_thresh = 0.95, scaled_prior_variance = 0.001, estimate_residual_variance = FALSE, estimate_prior_variance = TRUE, residual_variance = NULL, max_iter = 100, estimate_prior_method = "optim", var_y = NULL, plot_track_fit = FALSE, return_all_CS = TRUE, file_prefix = file.path(tempdir(), "SUSIE"), verbose = TRUE )
dat |
Fine-mapping results data. |
LD_matrix |
Linkage Disequilibrium (LD) matrix to use for fine-mapping. |
case_control |
Whether the summary statistics come from a case-control
study (e.g. a GWAS of having Alzheimer's Disease or not) ( |
max_causal |
The maximum number of non-zero effects (and thus causal variants). |
compute_n |
How to compute per-SNP sample size (new column "N").
|
priors_col |
[Optional] Name of the a column in
|
rescale_priors |
If prior probabilities are supplied,
rescale them from 0-1 (i.e. |
credset_thresh |
The minimum mean Posterior Probability (across all fine-mapping methods used) of SNPs to be included in the "mean.CS" column. |
scaled_prior_variance |
The prior variance, divided by
|
estimate_residual_variance |
If
|
estimate_prior_variance |
If |
residual_variance |
Variance of the residual. If
|
max_iter |
Maximum number of IBSS iterations to perform. |
estimate_prior_method |
The method used for estimating prior
variance. When |
var_y |
[Optional] User-supplied phenotypic variance value(s). Can be one of the following:
|
plot_track_fit |
Record each iteration and make a GIF of the fine-mapping algorithm learning the causal variants. WARNING!: Making this plot can take a long time if there's many iterations. |
return_all_CS |
If >1 Credible Set is identified,
return them all ( |
file_prefix |
Prefix to path of output plot file. If not
specified, the plot, or plots, will be saved to a temporary
directory generated using |
verbose |
Print messages. |
Notes on convergence:
susieR will often give the warning:
IBSS algorithm did not converge in 100 iterations!
.
This means the results might not necessarily be reliable.
There's several things you can try to avoid this:
Make sure susieR
is up-to-date:
devtools::install_github("stephenslab/susieR@0.9.0")
Increase max_causal
(e.g. 5 => 10).
Increase max_iter
(e.g. 100 => 1000),
though this will take longer.
Decrease the locus window size, which will also speed up the algorithm but potentially miss causal variants far from the lead SNP.
Changing estimate_prior_method
does not seem to affect
convergence warnings.
Notes on variance:
GitHub Issue
If estimate_residual_variance=TRUE
without
providing var_y
and L>1
, susieR will throw error:
Estimating residual variance failed: the estimated value is negative
Running susieR with var_y = var(b)
provides exactly
the same results.
dat <- echodata::BST1 LD_matrix <- echodata::BST1_LD_matrix dat2 <- echofinemap::SUSIE(dat=dat, LD_matrix=LD_matrix)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.