ukbschemas: Load the UK Biobank data schemas from the Internet or other...

Description Usage Arguments Details Value Examples

View source: R/ukbschemas.R

Description

Note: this is a convenience function to load the schemas directly from the UK Biobank website. For most purposes, it is recommended to use ukbschemas_db and load_db instead.

Usage

1
2
ukbschemas(silent = !interactive(), as_is = FALSE,
  url_prefix = UKB_URL_PREFIX)

Arguments

silent

Do not report progress. Defaults to FALSE.

as_is

Import the schemas into the database without tidying? Defaults to FALSE.

url_prefix

First part of the URL at which the schema files can be found. For local repositories, the directory with a trailing delimiter (i.e. / or \ or \\ as appropriate to your operating system).

Details

The UK Biobank data schemas are fetched via the Internet unless a different url_prefix is provided. If !as_is, they are tidied. Note that if the table structure has changed (i.e. has been changed by UK Biobank), then the function may fail partially or fully unless as_is == TRUE.

Value

A list of objects of class tbl_df (see tibble::tibble).

Examples

1
2
3
4
## Not run: 
sch <- ukbschemas()

## End(Not run)

bjcairns/ukbschemas documentation built on Nov. 4, 2019, 7:22 a.m.