Browse code

Updated many arguments to use camelCase - Also added type checking for qtle objects

dunstone-a authored on 21/04/2024 15:04:28
Showing 1 changed files
... ...
@@ -19,7 +19,7 @@ Distribution of estimated simulation parameters
19 19
 }
20 20
 \examples{
21 21
 qtle <- mockQTLE() 
22
-params <- qtleEstimate(qtle, thresh_sig = 0.05, thresh_null = 0.5)
22
+params <- qtleEstimate(qtle, threshSig = 0.05, threshNull = 0.5)
23 23
 plotSimulationParams(params=params)
24 24
 
25 25
 
Browse code

Update documentation - Added examples for callSignificance, replaceNAs and plotting functions - Needed to add elipses in "plotUpSet"

dunstone-a authored on 21/03/2024 13:42:27
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,26 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/plots.R
3
+\name{plotSimulationParams}
4
+\alias{plotSimulationParams}
5
+\title{Distribution of estimated simulation parameters}
6
+\usage{
7
+plotSimulationParams(params, n = 1e+05)
8
+}
9
+\arguments{
10
+\item{params}{Estimated simulation parameters from qtleEstimate.}
11
+
12
+\item{n}{Number of random values to sample for plots.}
13
+}
14
+\value{
15
+A ggplot2 object
16
+}
17
+\description{
18
+Distribution of estimated simulation parameters
19
+}
20
+\examples{
21
+qtle <- mockQTLE() 
22
+params <- qtleEstimate(qtle, thresh_sig = 0.05, thresh_null = 0.5)
23
+plotSimulationParams(params=params)
24
+
25
+
26
+}