config: Functions handling sship R package config

configR Documentation

Functions handling sship R package config

Description

Functions handling sship R package config

Usage

create_config(dir = ".")

write_config(config, dir = ".", filename = "_sship.yml")

get_config(dir = ".")

check_config(config)

Arguments

dir

string providing path to configuration file

config

list containing configuration

filename

string defining config filename

Value

A status message or list of config

Examples

# Create a new config file from package default
create_config(dir = tempdir())

# Get config
config <- get_config(system.file("sship.yml", package = "sship"))

# Check if config is valid
check_config(config)

# Write config to file
write_config(config, dir = tempdir())

sship documentation built on Dec. 28, 2022, 2:01 a.m.