Creates a forest plot to visualise partial genetic correlation results
Source:R/other_functions.R
forest_plot.Rd
Creates a forest plot to visualise partial genetic correlation results
Usage
forest_plot(
obj,
save_file = F,
file_name = NULL,
file_width = NULL,
conditions = NULL,
pairs = NULL,
order = "difference"
)
Arguments
- obj
an object containing the output from a call to
partial_ldsc()
- save_file
Should the graphic should be saved?
default=FALSE
, graphic will be displayed on the on-screen device (logical)- file_name
The name of the file to be saved (if
save_file
isTRUE
),default=NULL
, will use <forest_plot.jpeg>, extensions allowed are ".jpeg"/".pdf"/".tiff" (character)- file_width
The width of the figure to be saved (if
save_file
isTRUE
), to help with readability if the conditions' names are too long,default=NULL
(numeric)- conditions
The names of the conditions to be included,
default=NULL
, will use all conditions and all corresponding pairs, a maximum of 8 conditions (character)- pairs
The names of the pairs to be included,
default=NULL
, if provided, will overruleconditions
, a maximum of 30 pairs (character)- order
How to order the conditions, possibility to use the difference (
"difference"
), the unadjusted genetic correlation ("unadjusted"
), or the partial genetic correlation ("partial"
),default="difference"
(character)