pgs_get_all: Get all PGS's

View source: R/pgs-funcs.R

pgs_get_allR Documentation

Get all PGS's

Description

This function calls on [pgs_get] to read in wanted all PGS at specified significance levels (by default all 12)

Usage

pgs_get_all(
  s_levels = paste0("S", 1:12),
  pgs_path = NULL,
  genetic_match_file = NULL,
  include_cnt = FALSE,
  include_genetic_debug = FALSE
)

Arguments

s_levels

character vector of the significance levels wanted

pgs_path

path to the directory where the PGS's are stored

genetic_match_file

path to the file containing the MOAS-genetics matching and debugging information

include_cnt

logical, whether to keep SNP count information

include_genetic_debug

logical, whether to keep all columns in the genetic_match_file in the final output

Value

a tibble / data.frame

See Also

Other pgs-functions: pgs_add_all(), pgs_add_single(), pgs_add(), pgs_get_single(), pgs_get(), pgs_read()

Examples

## Not run: 

# In this version you dont need to specify the
# PGS you want, it will take all it finds in the
# folder path provided.
#

pgs_get_all(
    s_levels = c("S1", "S7", "S11"),
    pgs_path = "path/to/PGS_wAPOE/",
    genetic_match_file = "path/to/gID_MOAS_match.tsv",
)

## End(Not run)

LCBC-UiO/MOAS documentation built on Aug. 28, 2023, 3:29 a.m.