text: Search.setIndex({docnames:["api","example","format","history","index","install","quickstart","workflow"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["api.rst","example.rst","format.rst","history.rst","index.rst","install.rst","quickstart.rst","workflow.rst"],objects:{"genepi.GenEpi":{ArgumentsParser:[0,1,1,""],InputChecking:[0,1,1,""],main:[0,1,1,""]},"genepi.step1_downloadUCSCDB":{DownloadUCSCDB:[0,1,1,""]},"genepi.step2_estimateLD":{EstimateAlleleFrequency:[0,1,1,""],EstimateLDBlock:[0,1,1,""],EstimatePairwiseLD:[0,1,1,""]},"genepi.step3_splitByGene":{SplitByGene:[0,1,1,""],SplitMegaGene:[0,1,1,""]},"genepi.step4_singleGeneEpistasis_Lasso":{BatchSingleGeneEpistasisLasso:[0,1,1,""],FeatureEncoderLasso:[0,1,1,""],FilterInLoading:[0,1,1,""],LassoRegressionCV:[0,1,1,""],RandomizedLassoRegression:[0,1,1,""],SingleGeneEpistasisLasso:[0,1,1,""]},"genepi.step4_singleGeneEpistasis_Logistic":{BatchSingleGeneEpistasisLogistic:[0,1,1,""],FeatureEncoderLogistic:[0,1,1,""],FilterInLoading:[0,1,1,""],GenerateContingencyTable:[0,1,1,""],LogisticRegressionL1CV:[0,1,1,""],RandomizedLogisticRegression:[0,1,1,""],SingleGeneEpistasisLogistic:[0,1,1,""]},"genepi.step5_crossGeneEpistasis_Lasso":{CrossGeneEpistasisLasso:[0,1,1,""],LassoRegression:[0,1,1,""],RegressorModelPersistence:[0,1,1,""]},"genepi.step5_crossGeneEpistasis_Logistic":{ClassifierModelPersistence:[0,1,1,""],CrossGeneEpistasisLogistic:[0,1,1,""],GenerateContingencyTable:[0,1,1,""],LogisticRegressionL1:[0,1,1,""],PlotPolygenicScore:[0,1,1,""],fsigmoid:[0,1,1,""]},"genepi.step6_ensembleWithCovariates":{ClassifierModelPersistence:[0,1,1,""],EnsembleWithCovariatesClassifier:[0,1,1,""],EnsembleWithCovariatesRegressor:[0,1,1,""],LoadDataForEnsemble:[0,1,1,""],RegressorModelPersistence:[0,1,1,""]},genepi:{GenEpi:[0,0,0,"-"],step1_downloadUCSCDB:[0,0,0,"-"],step2_estimateLD:[0,0,0,"-"],step3_splitByGene:[0,0,0,"-"],step4_singleGeneEpistasis_Lasso:[0,0,0,"-"],step4_singleGeneEpistasis_Logistic:[0,0,0,"-"],step5_crossGeneEpistasis_Lasso:[0,0,0,"-"],step5_crossGeneEpistasis_Logistic:[0,0,0,"-"],step6_ensembleWithCovariates:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:function"},terms:{"\u03c72":[0,6],"case":[1,2],"default":0,"final":[2,4],"float":0,"function":[0,1,2,4,5],"int":0,"public":[4,7],"return":0,"true":2,Added:3,For:[4,5,7],PGS:0,The:[0,2,4,6,7],Then:[0,1],These:5,Use:5,Using:4,about:2,accord:6,add:3,addit:7,adopt:[0,4],advantag:0,after:[2,5],again:4,age:2,ailab:4,all:[0,1,2,3,6,7],all_logist:2,all_logistic_k2:[2,6],allel:0,also:[2,6,7],altern:0,among:0,analysi:2,ani:[3,4,5],annot:0,api:[4,7],apo:[2,6],apoc1:[2,6],apoc1_23:[2,6],apoc1_featur:[2,6],apoc1_result:[2,6],apoe_11:[2,6],apoe_featur:[2,6],apoe_result:[2,6],appli:[4,5],approach:[0,4],apr:0,architectur:4,arg:[0,6],argpars:0,argument:[0,1,2,3,5],argumentpars:0,argumentspars:0,arrai:0,associ:[0,4],author:0,automat:[2,5,6],avali:4,averag:0,awai:6,azur:5,base:[2,4],batch:[0,3],batchsinglegeneepistasislasso:0,batchsinglegeneepistasislogist:0,becaus:[0,4],bed:2,befor:0,believ:4,below:[2,7],besid:2,between:[0,6],bewteen:7,bfile:2,bim:2,bin:3,biorxiv:4,block:[0,1,2,5],bmcbioinformat:0,both:[1,4],boundari:4,browser:1,build:[0,2,4,5],c4lab:4,calcul:5,call:2,can:[0,1,2,4],care:5,caus:[5,6],causal:6,chanc:4,chang:[0,3,4],changelog:3,check:[0,1,5],chen:4,chester:0,chi:0,chien:4,choos:[1,5],chose:0,chromosom:[0,2,6],chuan:[0,4],classif:[1,2,5],classifi:[0,2,3,6],classifier_covari:[2,6],classifiermodelpersist:0,clinic:4,colon:2,column:[2,6],combin:4,combinator:4,combinatori:[0,4],command:[1,2,5,6],common:2,compress:[1,2,5],compressld:[1,2,5],consid:[2,4],consist:0,consol:[5,6],consum:5,contain:[0,2,5],content:6,conting:0,control:[0,1,2],convert:2,coordin:[0,6],copi:2,correl:0,correspond:2,cost:2,could:[1,2,4,5,6],covari:[0,6],creat:0,criteria:0,criterion:0,cross:[0,1,2,4,5,6],crossgeneepistasi:0,crossgeneepistasislasso:0,crossgeneepistasislogist:0,crossgeneresult:[4,6],csv:[1,2,6],csv_file:1,current:[4,6],data:[0,4,5],databas:[0,1,2,5,6,7],dataset:[0,5],ddx11l1:2,deal:3,defiend:3,defin:[4,5],denot:6,depend:[0,4],describ:[6,7],descript:2,design:4,detail:2,detect:[0,4,6],develop:[0,4],differ:2,dimens:[0,2,4],dimension:[0,7],directli:6,discov:2,discoveri:4,discrimin:0,discuss:6,disequilibrium:[0,1,2,7],distribut:0,doc:3,document:[3,4,7],done:[0,6],down:[0,6],download:1,downloaducscdb:0,dprime:0,dump:0,e32:5,each:[0,2,4,6],eampl:2,effect:2,element:[0,4],enabl:[1,2,5],encod:[0,3,4],end:[0,2],enhanc:4,ensembl:[0,2,3,6],ensemblewithcovariatesclassifi:0,ensemblewithcovariatesregressor:0,environment:[2,4],episatasi:6,episatsi:2,epistasi:[0,2,4,5,6],epistati:6,error:5,estim:[0,2,4,6],estimateallelefrequ:0,estimateldblock:0,estimatepairwiseld:0,etc:4,everi:2,exampl:[2,4,6],exce:0,exclud:0,excut:1,execut:5,exhibit:0,exit:[1,5],expect:0,extract:[0,6],f1score:2,factor:[2,4],fals:4,fam138f:2,fam:2,featur:[0,2,3,4,6,7],featureencoderlasso:0,featureencoderlogist:0,feb:0,figur:[0,7],file:[0,1,3,4,5,6],filenam:[1,2,5],filepath:2,filter:0,filterinload:0,find:[6,7],first:[0,2,3,4,6],float_avg_s_p:0,float_avg_s_p_test:0,float_avg_s_p_train:0,float_d_prim:0,float_f1scor:0,float_f1score_test:0,float_f1score_train:0,float_frequency_a:0,float_frequency_b:0,float_r_squar:0,float_threshold_dprim:0,float_threshold_rsquar:0,fold:[0,1,2,5,6],folder:[0,4,6],follow:[1,2,4,6],fomat:[4,6],forest:3,format:[1,2],frequenc:[0,6],from:[0,4,6,7],front:2,fsigmoid:0,full_path_of_your_:1,full_path_of_your_genome_region_fil:1,futur:2,gen:[0,1,2,5,6],gen_fil:1,gen_snp:0,gen_snp_1:0,gen_snp_2:0,gene:[0,2,3,4,5,6,7],genepi:[1,2,3,5,6,7],genepi_log_d:[2,6],gener:[0,2,4,6],generatecontingencyt:0,genesymbol:2,genesymbol_featur:2,genesymbol_numberofvariantsongen:2,genesymbol_result:2,genet:[0,2,4,6],genom:[0,3,4,5,6],genotyp:[0,4,6],get:6,ghz:5,giacomini:4,gib:5,gnome:4,group:[0,2,4],han:4,has:2,have:4,head:2,header:2,help:[1,5],here:[5,6],hg19:[0,1,2,5],hg38:[1,5],high:0,higher:4,highli:0,histori:4,hong:4,how:[4,6],hsieh:4,human:[0,1,2,5],implant:0,implement:[0,7],impute2:2,includ:[0,6],independ:4,indic:[2,6],individu:4,influenc:4,inform:[0,2,6,7],input:[0,1,4,5],inputcheck:0,instal:[3,4],int8:0,int_dim:0,int_kofkfold:0,int_njob:0,int_num_genotyp:0,int_num_phenotyp:0,int_step:0,int_window:0,intel:5,inter:7,interact:4,interpret:[2,4],introduc:6,introduct:7,its:[0,5,6],jen:4,june:4,kathleen:4,keep:2,kgxref:0,kind:2,knowngen:0,laptop:5,larg:5,largest:0,lasso:[0,2],lassoregress:0,lassoregressioncv:0,last:[2,6],ldblock:[4,6],learn:[4,5],lewontin:0,line:2,linkag:[0,1,2,7],list:[0,1,5,6],list_interaction_rsid:0,list_snpsongen:0,load:[0,6],loaddataforensembl:0,local:0,locat:6,loci:4,locu:4,log10:6,log:[0,3,4],logist:0,logisticregressionl1:0,logisticregressionl1cv:0,low:[0,4,6],macbook:5,machin:4,mai:6,main:[0,2,4,7],mean:[0,6],mega:3,memori:[3,5],messag:[1,5],method:2,microsoft:5,might:[4,5],ming:4,minor:0,model:[0,1,2,3,4,5,6],modifi:1,modul:[4,6],molecular:4,more:[4,6],moreov:2,moudl:2,multiprocess:3,name:[0,2],nation:4,ndarrai:0,nearbi:0,next:7,none:[0,2],notabl:3,np_conting:0,np_genotyp:0,np_genotype_rsid:0,np_interact:0,np_phenotyp:0,np_x:0,np_y:0,number:[0,1,2,5],numpi:5,obtain:[0,1,6],odd:6,offici:0,often:0,onli:2,option:[1,5],or4f5:2,order:[0,2],other:[0,2,4],out:2,output:[0,1,3,4,5,6],over:5,overal:2,oxford:2,oyang:4,packag:[4,5],pairwis:6,paper:4,paramet:[0,1],pars:0,parser:3,particular:4,path:[0,1,2,5,6],peason:0,perform:[2,4],persist:[0,2,3],phenotyp:[0,1,4,5],ping:4,pip:5,pkl:[2,6],pleas:[1,2,4,6,7],plink:2,plot:0,plotpolygenicscor:0,polygen:0,pool:4,porcess:4,posit:[0,4,6],potenti:6,practic:0,pre:[4,7],precedur:7,predict:[2,4],prefer:0,prefixofthefilenam:2,prepar:[1,2],preval:0,preview:3,previou:[2,5],prime:[1,2,5],print:[4,6],procedur:7,process:[2,7],processor:5,produc:4,progress:6,project:[0,2,3],promot:4,proport:0,protect:6,provid:2,psutil:5,pvrl2:[2,6],pvrl2_48:[2,6],pvrl2_featur:[2,6],pvrl2_result:[2,6],pymysql:5,python:5,qualiti:0,quantit:[4,6],quick:[2,3,4,5],quickli:6,quickstart:4,ram:5,random:3,randomizedlassoregress:0,randomizedlogisticregress:0,rate:4,ratio:6,raw:2,read:3,real:5,recod:2,recommend:5,reconstruct:2,record:[0,2],reduc:[0,2,3,7],reduct:[0,2,4],refer:[0,2,5],regard:0,region:[0,3,4,5],regress:[0,1,4,5,6],regressor:[0,2,3],regressor_covari:2,regressormodelpersist:0,regular:[0,4,6],releas:4,remov:3,repres:[0,2,6],requir:4,respect:2,respons:0,result:[2,4],retain:2,retriev:[0,7],row:2,rs1081105:2,rs1081106:2,rs11668327_aa:6,rs117656888:2,rs157580_bb:6,rs191315680:2,rs2238681_aa:6,rs283811_bb:6,rs429358:2,rs429358_aa:6,rs449647_aa:6,rs59007384_bb:6,rs7254892_aa:6,rs73052335_aa:6,rs7412:2,rs769449_ab:6,rsid:[0,6],rsid_genotyp:6,rsquar:0,rule:2,run:[0,2,3,4,5],same:[0,2],sampl:[0,1,2,6],sample_ldreduc:[2,6],sample_q:1,scan:3,scientif:4,scikit:5,scipi:5,score:[0,2,6],second:[0,2,4,6],section:[2,6,7],see:[2,5],seld:4,select:[0,4,6],selet:6,self:[2,3,4,5],sequenti:2,set:[0,2,4],should:[0,2,5,6],show:[1,5],sign:[2,6],signific:6,significantli:6,sinc:[2,6],singl:[0,2,4,6],singlegeneepistasi:0,singlegeneepistasislasso:0,singlegeneepistasislogist:0,singlegeneresult:[4,6],six:7,size:0,slide:[0,3],smaller:0,snp:[0,2,4,5,6],snpsubset:[0,4,6],snptest:2,sook:4,sort:[0,6],sourc:0,spearman:0,speci:3,specif:5,split:[0,6],splitbygen:0,splite:2,splitmegagen:0,squar:[0,1,2,5],stabil:[0,4],stage:[0,2,4],star:6,start:[0,2,6],statist:[2,6],step1:[0,6],step1_downloaducscdb:4,step2:[0,6],step2_estimateld:4,step3:[0,6],step3_splitbygen:4,step4:[0,6],step4_singlegeneepistasis_lasso:4,step4_singlegeneepistasis_logist:4,step5:[0,6],step5_crossgeneepistasis_lasso:4,step5_crossgeneepistasis_logist:4,step6:[0,6],step6_ensemblewithcovari:4,step:[0,7],storag:5,store:2,str:0,str_hgbuild:0,str_inputfilename_featur:0,str_inputfilename_genotyp:0,str_inputfilename_phenotyp:0,str_inputfilename_scor:0,str_inputfilename_ucscdb:0,str_inputfilepath_featur:0,str_inputfilepath_genotyp:0,str_outputfilenam:0,str_outputfilepath:0,strand:2,structur:[2,6],student:6,studi:4,sub:6,submodul:7,submoudl:7,subset:[0,2],success:0,sucessfulli:5,support:[1,2,3,5],symbol:[0,6],system:4,tabl:[0,2,4],tai:4,taiwan:4,take:[0,2,5],task:6,test:[0,1,2,3,4,5],text:2,than:0,them:[2,4],thi:[0,1,2,3,4,5,6],thread:[0,1,2,5],three:6,threshold:[0,2,4,5],time:[2,6],togeth:4,tomm40:[2,6],tomm40_67:[2,6],tomm40_featur:[2,6],tomm40_result:[2,6],tool:2,total:0,train:[0,2,6],tree:[2,6],tung:4,tupl:0,two:[0,2,4,6,7],txt:[0,2,6],type:[0,1,2,5],ucsc:[0,1,2,5,6],ucscgenomedatabas:0,uncov:4,univers:4,unreli:6,updat:[1,2,5],updatedb:[1,2,5],usag:[3,4,5,6],usc:1,use:[1,2,4,6],used:[0,2,6],user:[0,4],using:[6,7],valid:[0,1,2,5],valu:[0,6],varaint:0,variant:[0,2,4],variat:2,vcf:2,wah:4,wai:4,warn:[0,6],wash7p:2,weight:6,were:[0,6],when:[3,4,5],where:[0,6],whether:6,which:[2,5,6],whole:5,wide:5,window:[0,3],within:4,without:2,word:[0,4],work:[4,6],workflow:0,xeon:5,yee:4,yen:4,you:[1,2,4,5,6],your:[2,4,6]},titles:["API Documentations","More Usage Examples","I/O File Fomats","Release History","Welcome to GenEpi\u2019s docs!","Installation","Quickstart","How it Works"],titleterms:{For:1,api:0,appli:1,build:1,chang:1,cite:4,crossgeneresult:2,data:[1,2],defin:[1,2],depend:5,dimens:1,doc:4,document:0,exampl:1,file:2,folder:2,fomat:2,genepi:[0,4],genom:[1,2],genotyp:2,histori:3,how:[5,7],input:2,instal:5,interpret:6,introduct:4,ldblock:2,log:2,main:6,modul:0,more:1,output:2,phenotyp:2,porcess:2,quantit:1,quick:6,quickstart:6,reduct:1,region:[1,2],releas:3,requir:5,result:6,run:6,seld:2,self:1,singlegeneresult:2,snpsubset:2,step1_downloaducscdb:0,step2_estimateld:0,step3_splitbygen:0,step4_singlegeneepistasis_lasso:0,step4_singlegeneepistasis_logist:0,step5_crossgeneepistasis_lasso:0,step5_crossgeneepistasis_logist:0,step6_ensemblewithcovari:0,studi:1,system:5,tabl:6,test:6,threshold:1,usag:1,welcom:4,work:7,your:1}})