prepare_metadata: prepare_metadata Function

In matthewhirschey/bespokelearnr: Bespoke data science learning

Description

This function allows you to prepare metadata for your bespoke dataset. If from_template = FALSE, then the function is expecting a bunch of variables to be assigned. If from_template = TRUE, then a 'dummy' template is made. This step is not necessary if using default mtcars dataset

Usage

prepare_metadata(
  bespoke_dataframe = NULL,
  dataframe_name = "INSERT_NAME",
  dataframe_title = "INSERT_TITLE",
  dataframe_source = "INSERT_SOURCE",
  dataframe_desc = "INSERT_DESC",
  dataframe_about = "INSERT_ABOUT",
  dataframe_join_name = "INSERT_JOIN_NAME",
  dataframe_join_about = "INSERT_JOIN_ABOUT",
  test = FALSE
)

Arguments

bespoke_dataframe	name of an object in your global environment from which you created a bespoke dataset
dataframe_name	Name of your dataframe
dataframe_title	Title of your dataframe
dataframe_source	Source of your dataframe
dataframe_desc	Description of your dataframe
dataframe_about	About your dataframe
dataframe_join_name	Name of your dataframe for joining
dataframe_join_about	About your dataframe for joining
test	A logical for developing function in inst/tutorials dir vs. installing function in tutorials dir

matthewhirschey/bespokelearnr documentation built on Oct. 11, 2020, 12:57 a.m.