get_header_viewr: Extract header info from imported viewr object

Description Usage Arguments Value Author(s) Examples

View source: R/utility_functions.R

Description

A function to quickly return the information stored in the header of the original data file imported via pathviewr's read_ functions.

Usage

1
get_header_viewr(obj_name, ...)

Arguments

obj_name

The input viewr object; a tibble or data.frame with attribute pathviewr_steps that includes "viewr" pathviewr_steps

...

Additional arguments that may be passed to other pathviewr functions

Value

The value of the header attribute, or NULL if no exact match is found and no or more than one partial match is found.

Author(s)

Vikram B. Baliga

Examples

1
2
3
4
5
6
7
8
9
library(pathviewr)

## Import the Motive example data included in the package
motive_data <-
  read_motive_csv(system.file("extdata", "pathviewr_motive_example_data.csv",
                             package = 'pathviewr'))

## Now display the Header information
get_header_viewr(motive_data)

pathviewr documentation built on May 6, 2021, 9:07 a.m.