| topOverlappedStudies {otargen} | R Documentation |
Retrieve top studies having overlap in identified loci.
Description
For a provided study ID, the function, retrieves top studies with overlap in their identified loci with the queried study loci.
Usage
topOverlappedStudies(study_id, pageindex = 0, pagesize = 20)
Arguments
study_id |
Character: Open Targets Genetics generated ID for a GWAS study. |
pageindex |
Integer: Index of the current page for pagination (>= 0). |
pagesize |
Integer: Number of records in a page for pagination (> 0). |
Value
Returns a data frame with the top studies containing the following columns:
study.studyId: Character. Study ID of the input study.study.traitReported: Character. Reported trait of the input study.study.traitCategory: Character. Category of the trait in the input study.topStudiesByLociOverlap.studyId: Character. Study ID of the top associated studies.topStudiesByLociOverlap.study.studyId: Character. Study ID of the top associated studies.topStudiesByLociOverlap.study.traitReported: Character. Reported trait of the top associated studies.topStudiesByLociOverlap.study.traitCategory: Character. Category of the trait in the top associated studies.topStudiesByLociOverlap.numOverlapLoci: Integer. Number of loci overlapped with the input study.
Examples
## Not run:
result <- topOverlappedStudies(study_id = "GCST006614_3")
result <- topOverlappedStudies(study_id = "NEALE2_6177_1", pageindex = 1, pagesize = 50)
## End(Not run)