From bb10e712e69a973075d48ba63df284aaa67add37 Mon Sep 17 00:00:00 2001 From: Dan-RAI Date: Fri, 28 Oct 2022 12:23:38 +0200 Subject: [PATCH] doc fix --- docs/_sources/index.rst.txt | 2 +- docs/index.html | 2 +- docs/searchindex.js | 2 +- python/docs/source/index.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 87ba1c5..aef46b3 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -6,7 +6,7 @@ Welcome to PascalX's documentation! =================================== -PascalX is a python3 library (`source `_) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the `Pascal `_ methodology, which is based on :math:`\chi^2` statistics. The cummulative distribution function of the weighted :math:`\chi^2` distribution is calculated approximately or exactly via a multi-precision C++ implementation of Ruben's and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described `here `_. +PascalX is a python3 library (`source `_) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the `Pascal `_ methodology, which is based on :math:`\chi^2` statistics. The cummulative distribution function of the weighted :math:`\chi^2` distribution can be calculated approximately or exactly via a multi-precision C++ implementation of Ruben's and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described `here `_. **Highlights:** diff --git a/docs/index.html b/docs/index.html index 1180bf3..d1fa685 100644 --- a/docs/index.html +++ b/docs/index.html @@ -164,7 +164,7 @@

Welcome to PascalX’s documentation!

-

PascalX is a python3 library (source) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the Pascal methodology, which is based on \(\chi^2\) statistics. The cummulative distribution function of the weighted \(\chi^2\) distribution is calculated approximately or exactly via a multi-precision C++ implementation of Ruben’s and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described here.

+

PascalX is a python3 library (source) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the Pascal methodology, which is based on \(\chi^2\) statistics. The cummulative distribution function of the weighted \(\chi^2\) distribution can be calculated approximately or exactly via a multi-precision C++ implementation of Ruben’s and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described here.

Highlights:

    diff --git a/docs/searchindex.js b/docs/searchindex.js index 3feae03..662bda0 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["PascalX","index","install","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["PascalX.rst","index.rst","install.rst","usage.rst"],objects:{"PascalX.genescorer":{chi2sum:[0,0,1,""]},"PascalX.genescorer.chi2sum":{activateFails:[0,1,1,""],get_geneinfo:[0,1,1,""],get_topscores:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],plot_Manhattan:[0,1,1,""],plot_genesnps:[0,1,1,""],rank:[0,1,1,""],rank_mapper:[0,1,1,""],rescore:[0,1,1,""],save_GWAS:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_gene_bulk_chr:[0,1,1,""],test_gene_assocdir:[0,1,1,""]},"PascalX.genexpr":{genexpr:[0,0,1,""]},"PascalX.genexpr.genexpr":{chi2rank:[0,1,1,""],get_GTEX_expr:[0,1,1,""],load_expr:[0,1,1,""],load_genome:[0,1,1,""],plot_genexpr:[0,1,1,""]},"PascalX.genome":{genome:[0,0,1,""]},"PascalX.genome.genome":{gene_info:[0,1,1,""],get_ensembl_annotation:[0,1,1,""],load_genome:[0,1,1,""]},"PascalX.mapper":{mapper:[0,0,1,""]},"PascalX.mapper.mapper":{load_mapping:[0,1,1,""]},"PascalX.pathway":{chi2perm:[0,0,1,""],chi2rank:[0,0,1,""]},"PascalX.pathway.chi2perm":{get_sigpathways:[0,1,1,""],load_modules:[0,1,1,""],score:[0,1,1,""],set_genescorer:[0,1,1,""]},"PascalX.pathway.chi2rank":{get_sigpathways:[0,1,1,""],load_modules:[0,1,1,""],score:[0,1,1,""],set_genescorer:[0,1,1,""]},"PascalX.refpanel":{refpanel:[0,0,1,""]},"PascalX.refpanel.refpanel":{getChrSNPs:[0,1,1,""],getSNPtoChrMap:[0,1,1,""],load_pos_reference:[0,1,1,""],load_snp_reference:[0,1,1,""],set_refpanel:[0,1,1,""]},"PascalX.snpdb":{db:[0,0,1,""]},"PascalX.snpdb.db":{close:[0,1,1,""],get:[0,1,1,""],getKeys:[0,1,1,""],getPosatSNPs:[0,1,1,""],getSNPKeys:[0,1,1,""],getSNPatPos:[0,1,1,""],getSNPs:[0,1,1,""],getSortedKeys:[0,1,1,""],insert:[0,1,1,""],open:[0,1,1,""]},"PascalX.xscorer":{rsum:[0,0,1,""],zsum:[0,0,1,""]},"PascalX.xscorer.rsum":{get_topscores:[0,1,1,""],jointlyRank:[0,1,1,""],jointlyRank_mapper:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],matchAlleles_mapper:[0,1,1,""],plot_genesnps:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_map:[0,1,1,""]},"PascalX.xscorer.zsum":{get_topscores:[0,1,1,""],jointlyRank:[0,1,1,""],jointlyRank_mapper:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],matchAlleles_mapper:[0,1,1,""],plot_genesnps:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_map:[0,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"0":[0,2,3],"0001":0,"01":[0,3],"05":[0,3],"08":0,"1":[0,3],"10":[0,1,3],"100":[0,1],"1000":3,"100000":0,"1000000":0,"100d":0,"1010517":1,"11":0,"1101":3,"12":[0,3],"128b":0,"13":0,"1371":1,"14":0,"15":0,"16":[0,3],"17":0,"18":[0,1],"19":0,"1e":0,"1kg":3,"1mb":0,"2":[0,1,3],"20":0,"2021":3,"21":[0,3],"21257289":3,"22":[0,3],"3":[0,3],"37":3,"38":3,"4":[0,3],"4429922":1,"5":[0,3],"50000":[0,3],"50gb":3,"5281":1,"6":0,"64gb":2,"7":0,"8":0,"8888":2,"8gb":2,"9":[0,1],"99":[0,3],"case":3,"class":[0,3],"default":[0,2,3],"do":[0,3],"export":2,"float":0,"function":[0,1],"import":[0,3],"int":0,"new":[0,3],"return":[0,3],"static":0,"true":[0,3],"try":[0,3],A:[0,2,3],As:[2,3],By:3,For:[1,2,3],If:[0,1,3],In:[1,3],It:[0,3],NOT:0,No:1,Not:0,One:0,Or:2,The:[0,1,2,3],These:3,To:3,_band:0,_chr:0,_geneid:0,_geneidtosymb:0,_genesymb:0,_score:0,_skip:0,a1col:[0,3],a2col:[0,3],abov:[0,3],acceler:1,access:[0,1,3],accuraci:0,activ:0,activatefail:0,add:2,addit:[0,1,3],after:[0,2,3],against:[0,3],aggreg:[1,3],agplv3:1,algebra:1,algorithm:[0,1,3],all:[0,1,2,3],allel:[0,3],alloc:2,allow:[0,1,2],also:[0,3],alt:0,altern:[0,3],an:[0,1,3],annot:[0,3],anti:3,aoah:3,api:[1,3],appli:1,applic:[],approxim:[1,3],apt:2,ar:[0,3],argument:3,around:3,associ:[0,3],assum:3,auto:[0,3],automat:[0,3],autorescor:[0,3],avail:[0,2,3],b:3,background:0,band:0,bar:0,base:[0,1,3],bash:[2,3],bcol:[0,3],been:3,befor:3,being:2,below:3,bergmann:1,bergmannlab:2,beta:[0,3],between:[0,1,3],beyond:[],bind:2,biobank:1,biologi:1,biomart:[0,3],bool:0,boost:2,both:3,browser:2,bug:1,build:2,bulk:0,bullet:[],c:1,calcuat:[],calcul:[0,1,3],call:[0,3],can:[0,2,3],capabl:2,captur:0,carlo:3,cb:0,cbar_po:[0,3],ccol:0,cd:2,cdf:[1,3],cdh13:3,cetx:0,ch:1,charact:0,check:1,chi2:0,chi2perm:[0,3],chi2rank:[0,3],chi2sum:[0,3],chi:[1,3],choic:3,chr:[0,3],chrlist:0,chromatin:3,chromosom:[0,1,3],chrs_onli:0,chrstart:0,cid:0,cite:1,classic:0,clear:[],clone:2,close:[0,3],cmap:0,cmdline:[],code:[0,3],coher:[0,1,3],col:0,color:0,colormap:0,column:[0,3],com:2,come:0,comma:[0,3],command:[1,2],compar:3,compil:2,complement:3,compress:[0,3],comput:[0,1,2,3],conf:2,consid:0,consist:1,consult:3,contain:[0,3],contributor:1,converg:3,convert:3,coordin:0,core:[0,3],corrcmap:0,correct:[0,1],correl:0,correspond:[0,3],cost:3,could:0,count:3,covari:[],cpu:3,cr:0,crch38:0,creat:0,cross:[0,1,3],cs:0,csmd1:3,cstx:0,csymb:0,cummul:1,current:[0,3],cutoff:[0,3],d:[1,2],daniel:1,darkviolet:0,data:[0,1,2,3],databas:1,dataset:3,davi:[0,1],db:0,debian:1,defin:3,degre:3,delimit:[0,3],demo:3,depend:2,describ:[1,3],design:0,detail:0,dev:2,develop:2,dict:0,dictionari:[0,3],differ:[0,1,3],digit:1,direct:[0,3],directli:3,directori:2,displai:3,distanc:[0,3],distribut:[1,3],docker:[1,3],document:3,doe:[2,3],doi:[1,3],done:[0,3],download:[0,3],draw:0,due:3,e1010517:1,e_a:[0,3],e_b:[0,3],each:[0,3],eigenvalu:3,either:[0,3],element:0,end:[0,3],enough:3,enrich:[0,1,3],ensembl:[0,3],ensemble_hg38:0,epsilon:0,eqtl:3,equal:[0,3],error:[],etc:[1,2],eur:3,evalu:[0,3],eventu:3,exact:3,exactli:1,exampl:[0,3],exclus:[],execut:3,exist:[0,3],exlus:2,experiment:[1,3],express:[0,3],extend:3,extern:[1,3],factor:0,fail:[0,3],fals:[0,3],farp2:3,fashion:3,fast:[0,1],fcol:[0,3],featur:3,figur:[],file:[0,3],filenam:[0,3],filenamea:3,filenameb:3,filter:[0,3],finish:0,first:[0,3],fix:[],folder:3,follow:[0,1,2,3],forc:0,form:0,format:0,fourth:3,freedom:3,from:[0,3],full:[0,2,3],fulli:3,fuse:[0,3],fusion:3,g:[0,2,3],gap:0,gcol:[0,3],ge:3,gene1:0,gene2:0,gene:[0,1],gene_info:0,gener:[0,1,3],genes_onli:0,genescor:[1,3],genetyp:[0,3],genexpr:[0,3],genexprscor:1,genom:[1,3],genotyp:[0,3],get1kggrch38:3,get:0,get_ensembl_annot:[0,3],get_ensemble_annot:0,get_geneinfo:0,get_gtex_expr:[0,3],get_sigpathwai:0,get_topscor:0,getchrsnp:0,getkei:0,getposatsnp:0,getsnp:0,getsnpatpo:0,getsnpkei:0,getsnppo:[],getsnptochrmap:0,getsortedkei:0,git:2,github:[1,2],given:[0,1,3],global:3,gnu:2,go:[],gpu:[0,1],grch37:[0,3],grch38:[0,3],group:0,gtex:[0,3],guarante:1,gwa:[0,1,2,3],gwasa:3,gwasid1:0,gwasid2:0,gz:[0,3],gzip:[0,3],h:3,ha:[0,3],handl:0,have:[0,3],header:[0,2,3],help:3,helper:0,here:[1,3],high:[1,3],highlight:1,horizont:0,host:2,hour:[0,3],howev:[2,3],http:2,id:[0,3],idcol:0,ident:0,identifi:0,ignor:0,illustr:[],imag:2,impact:[],implement:[0,1],impli:1,inbetween:0,includ:[0,3],increas:3,index:0,indic:0,individu:[0,3],ineffici:0,infer:[],info:3,inform:[0,3],initi:[0,3],initialiaz:3,inner:0,inquiri:1,insert:0,instal:1,instanc:[0,3],instead:3,integr:0,interact:[2,3],interdepend:[],interfac:1,intern:0,intlimit:0,introduc:3,invers:[0,3],invert:0,invok:3,ip:2,issu:1,iter:3,its:1,job:3,joint:[0,3],jointli:[0,3],jointlyrank:[0,3],jointlyrank_mapp:0,journal:1,jupyt:2,keep:[0,3],keepfil:[0,3],kei:0,kept:[0,3],know:0,krefl:1,label:0,labellist:0,labelsig:0,larg:3,largest:3,last:3,latest:2,latter:3,ld:2,ld_library_path:2,lead:0,least:2,lefttail:[0,3],level:1,lib:2,libboost:2,libquadmath:2,librari:[1,2,3],like:3,limegreen:0,line:[0,1],linear:1,linux:3,list:[0,3],lists:3,llvm:2,lncrna:3,load:[0,3],load_expr:[0,3],load_genom:[0,3],load_gwa:[0,3],load_map:[0,3],load_modul:[0,3],load_pos_refer:0,load_refpanel:[0,3],load_scor:[0,3],load_snp_refer:0,localhost:2,locat:0,log10:0,log10p:0,log:0,log_:[],logsigthreshold:0,longer:0,m:[0,3],mac:1,machin:2,maco:2,made:2,maf:0,magnitud:[],mai:[0,3],main:1,make:[0,1,2],manhattan:[0,3],manual:3,map:[0,3],mapper:1,mark:[0,3],mark_window:[0,3],match:[0,3],matchallel:[0,3],matchalleles_mapp:0,matchrefpanel:0,matplotlib:3,matrix:0,max:[0,3],maximum:0,mean:[],member:3,memori:0,merg:0,mergedist:0,meta:[0,3],method:[0,3],methodolog:[1,3],mincutoff:0,minimum:2,misc:3,mode:[0,2],modern:1,modifi:3,modul:[0,3],moment:[],mont:3,more:[0,3],most:3,mount:2,multi:[1,3],n:[0,3],na:0,nageneid:0,naid:0,name:[0,3],nan:3,ncol:[0,3],ncolor:0,nearbi:0,necessari:3,need:[0,3],neg:0,nobar:0,non:[0,3],none:[0,3],normal:[0,1,3],note:3,notebook:2,novel:1,nsnp:3,number:[0,2,3],object:[0,3],observ:[],occur:0,ocol:[],offer:[1,3],often:3,onc:[0,3],one:[0,3],onli:[0,3],open:[0,1,2],oper:[1,3],option:[0,3],order:[0,3],org:0,origin:3,os:3,other:3,out:3,over:[0,1],overestim:[],overlap:[0,3],own:[1,3],p:[0,1,2,3],packag:[0,1],page:1,pair:[0,3],panel:[1,2,3],parallel:[0,1,2,3],param:[],paramet:[0,3],particular:3,pascal:[1,3],pascalx:[0,2,3],path:[0,2,3],pathtostor:3,pathwai:[0,1],pathwaynam:3,pathwayscor:1,pcbi:1,pcol:[0,3],pcolor:0,pcorr:0,pearson:[0,3],peer:3,per:[0,3],perform:[0,1,3],persist:[0,2,3],pfilter:0,pickl:[0,3],pip:2,platform:[1,3],pleas:[1,2,3],plink:3,plo:1,plot:[0,3],plot_genesnp:[0,3],plot_genexpr:[0,3],plot_manhattan:[0,3],po:0,point:3,posit:[0,3],possess:3,possibl:3,potenti:3,preced:0,precis:[0,1,2,3],prepend:3,preprint:3,present:0,previou:0,print:0,probabl:0,produc:0,product:1,progress:0,project:3,protein_cod:[0,3],provid:0,proxim:3,pscorer:3,pseudogen:0,pval:3,pvalg1:3,pvalu:0,pw:3,py:2,pyplot:3,python3:[1,2,3],python:2,qq:[0,3],quadmath:2,qualiti:0,qualityt:0,queri:0,r:3,r_fail:3,r_success:3,r_totalfail:3,ram:2,random:[0,1,3],randomli:3,rang:[],rank:[0,3],rank_mapp:0,ratio:[0,3],raw:[0,3],rcol:[0,3],re:[0,3],read:3,reason:3,recod:3,recommend:[2,3],reduc:3,ref:0,refer:[1,2,3],refernc:3,refpanel:[0,3],regex:0,region:0,regular:0,remain:0,remov:[0,3],replac:3,report:1,reqacc:0,request:0,requir:[0,2,3],rescor:[0,3],research:1,resourc:2,respect:3,result:[0,1,3],retain:3,retriev:0,review:3,root:2,routin:3,row:[0,3],rscol:[0,3],rsid1:0,rsid2:0,rsid:[0,3],rsum:[0,3],ruben:[0,1,3],run:[0,2,3],runtim:[2,3],s:[0,3],saddl:[0,3],same:[0,3],sampl:[0,3],satterthwait:0,save:[0,3],save_gwa:0,save_scor:[0,3],scale:1,scor:0,score:[0,1],score_al:[0,3],score_chr:[0,3],score_gene_bulk_chr:0,score_map:0,scorer:[0,1,3],scoringresult:0,script:3,second:[0,3],section:3,see:[],segment:0,select:[1,3],separ:[0,3],set:[0,2,3],set_genescor:0,set_refpanel:0,setup:2,setuptool:2,sever:[0,3],sh:3,share:0,should:[1,2,3],show:0,show_correl:[0,3],side:3,siglin:0,signific:[0,3],similar:3,simul:3,singl:0,size:[0,2,3],skip:[0,3],slowli:3,small:[],smallest:3,snp:1,snpdb:0,snpid:0,snponli:0,so:2,solei:3,sort:0,sourc:[0,1],sourcefilenam:0,space:0,specif:3,specifi:[0,3],split:0,splitchr:0,src:2,standard:3,start:[0,2,3],statist:[0,1,3],step:3,stop:2,storag:0,store:[0,3],str:0,strand:0,string:[0,3],style:0,subsequ:3,subset:3,success:0,successfulli:3,sudo:2,sudoer:2,suffici:[0,2],suitabl:3,sum:[0,3],summari:[0,1,3],suppli:[0,3],support:[1,2,3],symbol:[0,3],system:2,t:[0,2],tab:[0,3],tail:0,take:[0,3],taken:0,target:2,technic:1,tend:[],term:0,test:[0,1,3],test_gene_assocdir:0,text:[0,3],textfil:0,than:[0,3],thei:3,therefor:3,thi:[0,1,3],third:3,threshold:0,tick:0,ticket:1,tickspac:0,time:2,tissu:[0,1],tool:1,top:0,tped:[0,3],tpm:3,transcript:[0,3],transform:[0,3],transpos:3,trim26:3,tsv:3,two:[0,1,3],txt:[0,3],type:[0,2,3],tzscore:[0,3],ubuntu:1,uk:1,under:[0,1,3],uniform:3,unil:1,uniqu:0,unloadref:0,unlock:3,up:1,updat:0,us:[0,1,2,3],usag:[0,1],usenagen:0,user:0,util:3,v8:0,valid:3,valu:[0,1,3],varcutoff:[0,3],variabl:3,varianc:[0,3],variant:[0,3],variou:[],vcf:[0,3],veri:3,version:[0,3],via:[0,1,2,3],visit:2,visual:3,want:3,warn:0,warranti:1,wcol:0,wdr12:3,we:[2,3],weight:[0,1],welch:[],what:0,whatsoev:1,which:[0,1,3],why:[],window:[0,1,3],wise:[1,3],without:[0,3],work:[1,2],workdir:2,x:1,xcode:2,xscore:3,xscorer:[1,3],yet:3,you:[0,1,2,3],your:[1,2,3],your_filenam:3,yourannotationfil:3,yourgtexfilenam:3,yourpath:2,yourself:2,zenodo:1,zlib:0,zscore:0,zsum:[0,3]},titles:["API documentation","Welcome to PascalX\u2019s documentation!","Installation","Usage"],titleterms:{api:0,citat:1,cmdline:[],command:3,contact:1,content:1,databas:0,debian:2,docker:2,document:[0,1],gene:3,gener:[],genescor:0,genexprscor:0,genom:0,index:1,instal:2,interfac:3,librari:[],licens:1,line:3,mac:2,mapper:0,multi:2,panel:0,pascalx:1,pathwai:3,pathwayscor:0,platform:2,polici:1,refer:0,s:1,score:3,snp:[0,3],tissu:3,ubuntu:2,usag:3,welcom:1,window:2,x:3,xscorer:0}}) \ No newline at end of file +Search.setIndex({docnames:["PascalX","index","install","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["PascalX.rst","index.rst","install.rst","usage.rst"],objects:{"PascalX.genescorer":{chi2sum:[0,0,1,""]},"PascalX.genescorer.chi2sum":{activateFails:[0,1,1,""],get_geneinfo:[0,1,1,""],get_topscores:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],plot_Manhattan:[0,1,1,""],plot_genesnps:[0,1,1,""],rank:[0,1,1,""],rank_mapper:[0,1,1,""],rescore:[0,1,1,""],save_GWAS:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_gene_bulk_chr:[0,1,1,""],test_gene_assocdir:[0,1,1,""]},"PascalX.genexpr":{genexpr:[0,0,1,""]},"PascalX.genexpr.genexpr":{chi2rank:[0,1,1,""],get_GTEX_expr:[0,1,1,""],load_expr:[0,1,1,""],load_genome:[0,1,1,""],plot_genexpr:[0,1,1,""]},"PascalX.genome":{genome:[0,0,1,""]},"PascalX.genome.genome":{gene_info:[0,1,1,""],get_ensembl_annotation:[0,1,1,""],load_genome:[0,1,1,""]},"PascalX.mapper":{mapper:[0,0,1,""]},"PascalX.mapper.mapper":{load_mapping:[0,1,1,""]},"PascalX.pathway":{chi2perm:[0,0,1,""],chi2rank:[0,0,1,""]},"PascalX.pathway.chi2perm":{get_sigpathways:[0,1,1,""],load_modules:[0,1,1,""],score:[0,1,1,""],set_genescorer:[0,1,1,""]},"PascalX.pathway.chi2rank":{get_sigpathways:[0,1,1,""],load_modules:[0,1,1,""],score:[0,1,1,""],set_genescorer:[0,1,1,""]},"PascalX.refpanel":{refpanel:[0,0,1,""]},"PascalX.refpanel.refpanel":{getChrSNPs:[0,1,1,""],getSNPtoChrMap:[0,1,1,""],load_pos_reference:[0,1,1,""],load_snp_reference:[0,1,1,""],set_refpanel:[0,1,1,""]},"PascalX.snpdb":{db:[0,0,1,""]},"PascalX.snpdb.db":{close:[0,1,1,""],get:[0,1,1,""],getKeys:[0,1,1,""],getPosatSNPs:[0,1,1,""],getSNPKeys:[0,1,1,""],getSNPatPos:[0,1,1,""],getSNPs:[0,1,1,""],getSortedKeys:[0,1,1,""],insert:[0,1,1,""],open:[0,1,1,""]},"PascalX.xscorer":{rsum:[0,0,1,""],zsum:[0,0,1,""]},"PascalX.xscorer.rsum":{get_topscores:[0,1,1,""],jointlyRank:[0,1,1,""],jointlyRank_mapper:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],matchAlleles_mapper:[0,1,1,""],plot_genesnps:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_map:[0,1,1,""]},"PascalX.xscorer.zsum":{get_topscores:[0,1,1,""],jointlyRank:[0,1,1,""],jointlyRank_mapper:[0,1,1,""],load_GWAS:[0,1,1,""],load_genome:[0,1,1,""],load_mapping:[0,1,1,""],load_refpanel:[0,1,1,""],load_scores:[0,1,1,""],matchAlleles:[0,1,1,""],matchAlleles_mapper:[0,1,1,""],plot_genesnps:[0,1,1,""],save_scores:[0,1,1,""],score:[0,1,1,""],score_all:[0,1,1,""],score_chr:[0,1,1,""],score_map:[0,1,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"]},objtypes:{"0":"py:class","1":"py:method"},terms:{"0":[0,2,3],"0001":0,"01":[0,3],"05":[0,3],"08":0,"1":[0,3],"10":[0,1,3],"100":[0,1],"1000":3,"100000":0,"1000000":0,"100d":0,"1010517":1,"11":0,"1101":3,"12":[0,3],"128b":0,"13":0,"1371":1,"14":0,"15":0,"16":[0,3],"17":0,"18":[0,1],"19":0,"1e":0,"1kg":3,"1mb":0,"2":[0,1,3],"20":0,"2021":3,"21":[0,3],"21257289":3,"22":[0,3],"3":[0,3],"37":3,"38":3,"4":[0,3],"4429922":1,"5":[0,3],"50000":[0,3],"50gb":3,"5281":1,"6":0,"64gb":2,"7":0,"8":0,"8888":2,"8gb":2,"9":[0,1],"99":[0,3],"case":3,"class":[0,3],"default":[0,2,3],"do":[0,3],"export":2,"float":0,"function":[0,1],"import":[0,3],"int":0,"new":[0,3],"return":[0,3],"static":0,"true":[0,3],"try":[0,3],A:[0,2,3],As:[2,3],By:3,For:[1,2,3],If:[0,1,3],In:[1,3],It:[0,3],NOT:0,No:1,Not:0,One:0,Or:2,The:[0,1,2,3],These:3,To:3,_band:0,_chr:0,_geneid:0,_geneidtosymb:0,_genesymb:0,_score:0,_skip:0,a1col:[0,3],a2col:[0,3],abov:[0,3],acceler:1,access:[0,1,3],accuraci:0,activ:0,activatefail:0,add:2,addit:[0,1,3],after:[0,2,3],against:[0,3],aggreg:[1,3],agplv3:1,algebra:1,algorithm:[0,1,3],all:[0,1,2,3],allel:[0,3],alloc:2,allow:[0,1,2],also:[0,3],alt:0,altern:[0,3],an:[0,1,3],annot:[0,3],anti:3,aoah:3,api:[1,3],appli:1,applic:[],approxim:[1,3],apt:2,ar:[0,3],argument:3,around:3,associ:[0,3],assum:3,auto:[0,3],automat:[0,3],autorescor:[0,3],avail:[0,2,3],b:3,background:0,band:0,bar:0,base:[0,1,3],bash:[2,3],bcol:[0,3],been:3,befor:3,being:2,below:3,bergmann:1,bergmannlab:2,beta:[0,3],between:[0,1,3],beyond:[],bind:2,biobank:1,biologi:1,biomart:[0,3],bool:0,boost:2,both:3,browser:2,bug:1,build:2,bulk:0,bullet:[],c:1,calcuat:[],calcul:[0,1,3],call:[0,3],can:[0,1,2,3],capabl:2,captur:0,carlo:3,cb:0,cbar_po:[0,3],ccol:0,cd:2,cdf:[1,3],cdh13:3,cetx:0,ch:1,charact:0,check:1,chi2:0,chi2perm:[0,3],chi2rank:[0,3],chi2sum:[0,3],chi:[1,3],choic:3,chr:[0,3],chrlist:0,chromatin:3,chromosom:[0,1,3],chrs_onli:0,chrstart:0,cid:0,cite:1,classic:0,clear:[],clone:2,close:[0,3],cmap:0,cmdline:[],code:[0,3],coher:[0,1,3],col:0,color:0,colormap:0,column:[0,3],com:2,come:0,comma:[0,3],command:[1,2],compar:3,compil:2,complement:3,compress:[0,3],comput:[0,1,2,3],conf:2,consid:0,consist:1,consult:3,contain:[0,3],contributor:1,converg:3,convert:3,coordin:0,core:[0,3],corrcmap:0,correct:[0,1],correl:0,correspond:[0,3],cost:3,could:0,count:3,covari:[],cpu:3,cr:0,crch38:0,creat:0,cross:[0,1,3],cs:0,csmd1:3,cstx:0,csymb:0,cummul:1,current:[0,3],cutoff:[0,3],d:[1,2],daniel:1,darkviolet:0,data:[0,1,2,3],databas:1,dataset:3,davi:[0,1],db:0,debian:1,defin:3,degre:3,delimit:[0,3],demo:3,depend:2,describ:[1,3],design:0,detail:0,dev:2,develop:2,dict:0,dictionari:[0,3],differ:[0,1,3],digit:1,direct:[0,3],directli:3,directori:2,displai:3,distanc:[0,3],distribut:[1,3],docker:[1,3],document:3,doe:[2,3],doi:[1,3],done:[0,3],download:[0,3],draw:0,due:3,e1010517:1,e_a:[0,3],e_b:[0,3],each:[0,3],eigenvalu:3,either:[0,3],element:0,end:[0,3],enough:3,enrich:[0,1,3],ensembl:[0,3],ensemble_hg38:0,epsilon:0,eqtl:3,equal:[0,3],error:[],etc:[1,2],eur:3,evalu:[0,3],eventu:3,exact:3,exactli:1,exampl:[0,3],exclus:[],execut:3,exist:[0,3],exlus:2,experiment:[1,3],express:[0,3],extend:3,extern:[1,3],factor:0,fail:[0,3],fals:[0,3],farp2:3,fashion:3,fast:[0,1],fcol:[0,3],featur:3,figur:[],file:[0,3],filenam:[0,3],filenamea:3,filenameb:3,filter:[0,3],finish:0,first:[0,3],fix:[],folder:3,follow:[0,1,2,3],forc:0,form:0,format:0,fourth:3,freedom:3,from:[0,3],full:[0,2,3],fulli:3,fuse:[0,3],fusion:3,g:[0,2,3],gap:0,gcol:[0,3],ge:3,gene1:0,gene2:0,gene:[0,1],gene_info:0,gener:[0,1,3],genes_onli:0,genescor:[1,3],genetyp:[0,3],genexpr:[0,3],genexprscor:1,genom:[1,3],genotyp:[0,3],get1kggrch38:3,get:0,get_ensembl_annot:[0,3],get_ensemble_annot:0,get_geneinfo:0,get_gtex_expr:[0,3],get_sigpathwai:0,get_topscor:0,getchrsnp:0,getkei:0,getposatsnp:0,getsnp:0,getsnpatpo:0,getsnpkei:0,getsnppo:[],getsnptochrmap:0,getsortedkei:0,git:2,github:[1,2],given:[0,1,3],global:3,gnu:2,go:[],gpu:[0,1],grch37:[0,3],grch38:[0,3],group:0,gtex:[0,3],guarante:1,gwa:[0,1,2,3],gwasa:3,gwasid1:0,gwasid2:0,gz:[0,3],gzip:[0,3],h:3,ha:[0,3],handl:0,have:[0,3],header:[0,2,3],help:3,helper:0,here:[1,3],high:[1,3],highlight:1,horizont:0,host:2,hour:[0,3],howev:[2,3],http:2,id:[0,3],idcol:0,ident:0,identifi:0,ignor:0,illustr:[],imag:2,impact:[],implement:[0,1],impli:1,inbetween:0,includ:[0,3],increas:3,index:0,indic:0,individu:[0,3],ineffici:0,infer:[],info:3,inform:[0,3],initi:[0,3],initialiaz:3,inner:0,inquiri:1,insert:0,instal:1,instanc:[0,3],instead:3,integr:0,interact:[2,3],interdepend:[],interfac:1,intern:0,intlimit:0,introduc:3,invers:[0,3],invert:0,invok:3,ip:2,issu:1,iter:3,its:1,job:3,joint:[0,3],jointli:[0,3],jointlyrank:[0,3],jointlyrank_mapp:0,journal:1,jupyt:2,keep:[0,3],keepfil:[0,3],kei:0,kept:[0,3],know:0,krefl:1,label:0,labellist:0,labelsig:0,larg:3,largest:3,last:3,latest:2,latter:3,ld:2,ld_library_path:2,lead:0,least:2,lefttail:[0,3],level:1,lib:2,libboost:2,libquadmath:2,librari:[1,2,3],like:3,limegreen:0,line:[0,1],linear:1,linux:3,list:[0,3],lists:3,llvm:2,lncrna:3,load:[0,3],load_expr:[0,3],load_genom:[0,3],load_gwa:[0,3],load_map:[0,3],load_modul:[0,3],load_pos_refer:0,load_refpanel:[0,3],load_scor:[0,3],load_snp_refer:0,localhost:2,locat:0,log10:0,log10p:0,log:0,log_:[],logsigthreshold:0,longer:0,m:[0,3],mac:1,machin:2,maco:2,made:2,maf:0,magnitud:[],mai:[0,3],main:1,make:[0,1,2],manhattan:[0,3],manual:3,map:[0,3],mapper:1,mark:[0,3],mark_window:[0,3],match:[0,3],matchallel:[0,3],matchalleles_mapp:0,matchrefpanel:0,matplotlib:3,matrix:0,max:[0,3],maximum:0,mean:[],member:3,memori:0,merg:0,mergedist:0,meta:[0,3],method:[0,3],methodolog:[1,3],mincutoff:0,minimum:2,misc:3,mode:[0,2],modern:1,modifi:3,modul:[0,3],moment:[],mont:3,more:[0,3],most:3,mount:2,multi:[1,3],n:[0,3],na:0,nageneid:0,naid:0,name:[0,3],nan:3,ncol:[0,3],ncolor:0,nearbi:0,necessari:3,need:[0,3],neg:0,nobar:0,non:[0,3],none:[0,3],normal:[0,1,3],note:3,notebook:2,novel:1,nsnp:3,number:[0,2,3],object:[0,3],observ:[],occur:0,ocol:[],offer:[1,3],often:3,onc:[0,3],one:[0,3],onli:[0,3],open:[0,1,2],oper:[1,3],option:[0,3],order:[0,3],org:0,origin:3,os:3,other:3,out:3,over:[0,1],overestim:[],overlap:[0,3],own:[1,3],p:[0,1,2,3],packag:[0,1],page:1,pair:[0,3],panel:[1,2,3],parallel:[0,1,2,3],param:[],paramet:[0,3],particular:3,pascal:[1,3],pascalx:[0,2,3],path:[0,2,3],pathtostor:3,pathwai:[0,1],pathwaynam:3,pathwayscor:1,pcbi:1,pcol:[0,3],pcolor:0,pcorr:0,pearson:[0,3],peer:3,per:[0,3],perform:[0,1,3],persist:[0,2,3],pfilter:0,pickl:[0,3],pip:2,platform:[1,3],pleas:[1,2,3],plink:3,plo:1,plot:[0,3],plot_genesnp:[0,3],plot_genexpr:[0,3],plot_manhattan:[0,3],po:0,point:3,posit:[0,3],possess:3,possibl:3,potenti:3,preced:0,precis:[0,1,2,3],prepend:3,preprint:3,present:0,previou:0,print:0,probabl:0,produc:0,product:1,progress:0,project:3,protein_cod:[0,3],provid:0,proxim:3,pscorer:3,pseudogen:0,pval:3,pvalg1:3,pvalu:0,pw:3,py:2,pyplot:3,python3:[1,2,3],python:2,qq:[0,3],quadmath:2,qualiti:0,qualityt:0,queri:0,r:3,r_fail:3,r_success:3,r_totalfail:3,ram:2,random:[0,1,3],randomli:3,rang:[],rank:[0,3],rank_mapp:0,ratio:[0,3],raw:[0,3],rcol:[0,3],re:[0,3],read:3,reason:3,recod:3,recommend:[2,3],reduc:3,ref:0,refer:[1,2,3],refernc:3,refpanel:[0,3],regex:0,region:0,regular:0,remain:0,remov:[0,3],replac:3,report:1,reqacc:0,request:0,requir:[0,2,3],rescor:[0,3],research:1,resourc:2,respect:3,result:[0,1,3],retain:3,retriev:0,review:3,root:2,routin:3,row:[0,3],rscol:[0,3],rsid1:0,rsid2:0,rsid:[0,3],rsum:[0,3],ruben:[0,1,3],run:[0,2,3],runtim:[2,3],s:[0,3],saddl:[0,3],same:[0,3],sampl:[0,3],satterthwait:0,save:[0,3],save_gwa:0,save_scor:[0,3],scale:1,scor:0,score:[0,1],score_al:[0,3],score_chr:[0,3],score_gene_bulk_chr:0,score_map:0,scorer:[0,1,3],scoringresult:0,script:3,second:[0,3],section:3,see:[],segment:0,select:[1,3],separ:[0,3],set:[0,2,3],set_genescor:0,set_refpanel:0,setup:2,setuptool:2,sever:[0,3],sh:3,share:0,should:[1,2,3],show:0,show_correl:[0,3],side:3,siglin:0,signific:[0,3],similar:3,simul:3,singl:0,size:[0,2,3],skip:[0,3],slowli:3,small:[],smallest:3,snp:1,snpdb:0,snpid:0,snponli:0,so:2,solei:3,sort:0,sourc:[0,1],sourcefilenam:0,space:0,specif:3,specifi:[0,3],split:0,splitchr:0,src:2,standard:3,start:[0,2,3],statist:[0,1,3],step:3,stop:2,storag:0,store:[0,3],str:0,strand:0,string:[0,3],style:0,subsequ:3,subset:3,success:0,successfulli:3,sudo:2,sudoer:2,suffici:[0,2],suitabl:3,sum:[0,3],summari:[0,1,3],suppli:[0,3],support:[1,2,3],symbol:[0,3],system:2,t:[0,2],tab:[0,3],tail:0,take:[0,3],taken:0,target:2,technic:1,tend:[],term:0,test:[0,1,3],test_gene_assocdir:0,text:[0,3],textfil:0,than:[0,3],thei:3,therefor:3,thi:[0,1,3],third:3,threshold:0,tick:0,ticket:1,tickspac:0,time:2,tissu:[0,1],tool:1,top:0,tped:[0,3],tpm:3,transcript:[0,3],transform:[0,3],transpos:3,trim26:3,tsv:3,two:[0,1,3],txt:[0,3],type:[0,2,3],tzscore:[0,3],ubuntu:1,uk:1,under:[0,1,3],uniform:3,unil:1,uniqu:0,unloadref:0,unlock:3,up:1,updat:0,us:[0,1,2,3],usag:[0,1],usenagen:0,user:0,util:3,v8:0,valid:3,valu:[0,1,3],varcutoff:[0,3],variabl:3,varianc:[0,3],variant:[0,3],variou:[],vcf:[0,3],veri:3,version:[0,3],via:[0,1,2,3],visit:2,visual:3,want:3,warn:0,warranti:1,wcol:0,wdr12:3,we:[2,3],weight:[0,1],welch:[],what:0,whatsoev:1,which:[0,1,3],why:[],window:[0,1,3],wise:[1,3],without:[0,3],work:[1,2],workdir:2,x:1,xcode:2,xscore:3,xscorer:[1,3],yet:3,you:[0,1,2,3],your:[1,2,3],your_filenam:3,yourannotationfil:3,yourgtexfilenam:3,yourpath:2,yourself:2,zenodo:1,zlib:0,zscore:0,zsum:[0,3]},titles:["API documentation","Welcome to PascalX\u2019s documentation!","Installation","Usage"],titleterms:{api:0,citat:1,cmdline:[],command:3,contact:1,content:1,databas:0,debian:2,docker:2,document:[0,1],gene:3,gener:[],genescor:0,genexprscor:0,genom:0,index:1,instal:2,interfac:3,librari:[],licens:1,line:3,mac:2,mapper:0,multi:2,panel:0,pascalx:1,pathwai:3,pathwayscor:0,platform:2,polici:1,refer:0,s:1,score:3,snp:[0,3],tissu:3,ubuntu:2,usag:3,welcom:1,window:2,x:3,xscorer:0}}) \ No newline at end of file diff --git a/python/docs/source/index.rst b/python/docs/source/index.rst index 87ba1c5..aef46b3 100644 --- a/python/docs/source/index.rst +++ b/python/docs/source/index.rst @@ -6,7 +6,7 @@ Welcome to PascalX's documentation! =================================== -PascalX is a python3 library (`source `_) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the `Pascal `_ methodology, which is based on :math:`\chi^2` statistics. The cummulative distribution function of the weighted :math:`\chi^2` distribution is calculated approximately or exactly via a multi-precision C++ implementation of Ruben's and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described `here `_. +PascalX is a python3 library (`source `_) for high precision gene and pathway scoring for GWAS summary statistics. Aggregation of SNP p-values to gene and pathway scores follows the `Pascal `_ methodology, which is based on :math:`\chi^2` statistics. The cummulative distribution function of the weighted :math:`\chi^2` distribution can be calculated approximately or exactly via a multi-precision C++ implementation of Ruben's and Davies algorithm. This allows to apply the Pascal methodology to modern UK BioBank scale GWAS. In addition, PascalX offers a novel coherence test between two different GWAS on the level of genes, based on the product-normal distribution, as described `here `_. **Highlights:**