Diff of /man/shaPRS.Rd [000000] .. [6b94fb]

Switch to unified view

a b/man/shaPRS.Rd
1
% Generated by roxygen2: do not edit by hand
2
% Please edit documentation in R/shaPRS.R
3
\name{shaPRS}
4
\alias{shaPRS}
5
\title{Creates a new set of summary statistics}
6
\usage{
7
shaPRS(
8
  proximalLoc,
9
  adjunctLoc,
10
  outputLoc,
11
  rho = 0,
12
  discardAmbiguousSNPs = T,
13
  useProximalForMissing = T
14
)
15
}
16
\arguments{
17
\item{proximalLoc}{proximal LDPred formatted GWAS summary statistics table  that has header with the following columns: chr    pos    SNP    A1    A2    Freq1.Hapmap    b    se    p    N}
18
19
\item{adjunctLoc}{dataframe for adjunct dataset of the same signature}
20
21
\item{outputLoc}{the location of the output files}
22
23
\item{rho}{estimate of correlation between studies due to shared subjects. 0 for no overlap and 1 for complete overlap. default: 0. Obtain this from shaPRS_rho()}
24
25
\item{discardAmbiguousSNPs}{(optional) if ambiguous SNPs (G/C and A/T) should be discarded (default TRUE)}
26
27
\item{useProximalForMissing}{(optional) if SNPs missing from the adjunct data should be kept using the proximal data or not (default TRUE)}
28
}
29
\description{
30
it performs both steps of the shaPRS method in a single call:
31
(1) Creates lFDR corrected Q-test statistics for each SNP (via shaPRS_adjust)
32
(2) produce summary statistics according to a continuous weighting scheme (via shaPRS_blend_overlap)
33
(3) It writes to disk the following files with postfixes:   "_adjustinput", "_SNP_lFDR", "_shaprs", "_meta", which are the input and output for shaPRS_adjust (also required for shaPRS_LDGen), and shaPRS adjusted summary stats and a fixed-effect meta-analysis
34
}
35
\examples{
36
proximalLoc <- system.file("extdata", "phenoA_sumstats", package = "shaPRS")
37
adjunctLoc <- system.file("extdata", "phenoB_sumstats", package = "shaPRS")
38
shaPRS(proximalLoc, adjunctLoc, tempfile())
39
40
}