check_df_format: Checks the format of a data frame

Description Usage Arguments Value Examples

Description

Helper function to determine whether a supplied data frame is a specific data-formats defined in the package. Either returns a boolean or throws a stop.

Usage

1

Arguments

df

query data frame

format

format to test - see data-formats

dev_mode

stop if test is false. Default is FALSE

Value

string of data frame type

Examples

1
2
3
4
5
6
7
8
data(dietlein_data)
check_df_format(dietlein_data, 'resp_df')

data(example_tall_df)
check_df_format(example_tall_df, 'tall_df')

data(mtcars)
check_df_format(mtcars, 'tall_df')

chapmandu2/biotidyr documentation built on May 13, 2019, 3:29 p.m.