From fd48514bacf6283a7ce607999528990dd3ea6bf9 Mon Sep 17 00:00:00 2001 From: minsoo Date: Fri, 14 Jun 2024 21:39:38 -0700 Subject: [PATCH] docstrings --- src/plotld.jl | 10 ++++++---- src/plotlocus.jl | 11 ++++++----- src/plotqq.jl | 2 +- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/src/plotld.jl b/src/plotld.jl index d643912..f0247d4 100644 --- a/src/plotld.jl +++ b/src/plotld.jl @@ -5,10 +5,12 @@ Heatmap of symmetric correlation matrix `LD` with the diagonal elements on the x-axis. # Keyword arguments -- `threshold` : threshold below which values are ignored (default to `1/9`) -- `colormap` : colormap of values (default to `cgrad(:Blues_9, 9, categorical = true)`) -- `colorrange` : start and end points of `colormap` (default to `(0, 1)`) -- `strokewidth` : width of outline around heatmap boxes (default to `0`) +``` +threshold threshold below which values are ignored; default 1/9 +colormap colormap of values; default cgrad(:Blues_9, 9, categorical = true) +colorrange start and end points of colormap; default (0, 1) +strokewidth width of outline around heatmap boxes; default 0 +``` """ @recipe(PlotLD, LD) do scene Attributes( diff --git a/src/plotlocus.jl b/src/plotlocus.jl index c6b9984..2602ce8 100644 --- a/src/plotlocus.jl +++ b/src/plotlocus.jl @@ -68,11 +68,12 @@ and `range2`. Alternatively, plot within a given `chromosome` and a certain `window` around a genomic coordinate `bp` or plot within a certain `window` around `gene`. -# Arguments -- `ld::Union{Nothing, SnpData, Tuple{SnpData, Union{AbstractString, Tuple{AbstractString, Int}}}} = nothing`: - the reference panel for which LD is calculated. -- `ymax::Real`: the maximum value for y axis. -- `window::Real = 1e6`: the window around `bp` or `gene`. +# Keyword arguments +``` +ld::Union{Nothing, SnpData, Tuple{SnpData, Union{AbstractString, Tuple{AbstractString, Int}}}} default nothing +ymax maximum value for y-axis +window window around genomic coordinate or gene; default 1e6 +``` """ function plotlocus!( ax::Axis, diff --git a/src/plotqq.jl b/src/plotqq.jl index 847283a..6ab215c 100644 --- a/src/plotqq.jl +++ b/src/plotqq.jl @@ -7,7 +7,7 @@ Plot QQ plot of `P` values where the expected distribution is the uniform distri # Keyword arguments ``` xstep x-axis ticks step size; default 1 -ystep y-axis ticks step size: default 2 +ystep y-axis ticks step size; default 2 ``` """ function plotqq!(