make_prior_config: Make a prior configuration file

Description Usage Arguments Value Examples

View source: R/make_prior_config.R

Description

Makes a configuration file which you can use to specify the priors for your hybrid zone analysis. By default, creates the file in the working directory with the name prior_config_template.yaml. You can supply a filepath and a different name if you want to save the file somewhere else or with a different name. It will not overwrite files by default, you must set overwrite = T to do that.

Usage

1
2
make_prior_config(path = getwd(), name = "prior_config_template.yaml",
  overwrite = F)

Arguments

path

The folder where you wish to save the prior configuration file. The default is the current working directory.

name

The name you want to give the prior configuration file. The default is prior_config_template.yaml. File name must end in .yaml.

overwrite

Do you want to overwrite existing files? TRUE or FALSE, default is FALSE.

Value

invisible(NULL)

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# Make config file in current working directory with default name.
# Won't overwrite
make_prior_config()

# Make config file in a different folder with a new name.
# Will overwrite an existing file.
make_prior_config(path = "/path/to/directory", name = "my_priors.yaml", overwrite = T)

## End(Not run)

tjthurman/BAHZ documentation built on May 30, 2020, 8:28 a.m.