ingest_header: Ingest header data

Description Usage Arguments Details Value Examples

View source: R/ingest_header.R

Description

ingest_header reads in header information from datasets that were created using ingest_*. The dataset must have been ingested within the same R session. All ingest functions use the source file's base name as an identifying column to track provenance and relate data and metadata read from files.

Usage

1
ingest_header(input.source)

Arguments

input.source

Character indicating the source file, must match the input.source used to originally ingest the data

Details

All ingest_* functions for data files that include header data write that data to a temporary file. This header data can then be loaded and manipulated by the user using ingest_header.

Value

This function returns a dataframe containing the header information for the file. Refer to the help page for ingest_* for more information.

Examples

1
2
3
4
5
6
## Not run: 
campbell_file <- system.file("example_data", "campbell_scientific_tao5.dat", package = "ingestr")
cs_data <- ingest_campbell(input.source = campbell_file)
cs_header <- ingest_header(input.source = campbell_file)

## End(Not run)

jpshanno/ingestr documentation built on Sept. 24, 2020, 11:40 a.m.