formatted_example: Formatted example

View source: R/formatted_example.R

formatted_exampleR Documentation

Formatted example

Description

Returns an example of summary stats that have had their column names already standardised with standardise_header.

Usage

formatted_example(
  path = system.file("extdata", "eduAttainOkbay.txt", package = "MungeSumstats"),
  formatted = TRUE,
  sorted = TRUE
)

Arguments

path

Path to raw example file. Default to built-in dataset.

formatted

Whether the column names should be formatted (default:TRUE).

sorted

Whether the rows should be sorted by genomic coordinates (default:TRUE).

Value

sumstats_dt

Examples

sumstats_dt <- MungeSumstats::formatted_example()

neurogenomics/MungeSumstats documentation built on Aug. 10, 2024, 5:59 a.m.