Execute entire strata project
Description
main()
will read the .toml
files inside the project_path
and begin sourcing the strata
and laminae
in the order specified by the
user, with or without logging messages.
When a strata project is created main.R
is added to the project root. This
script houses main()
, and this file is the entry point to the project and
should be the target for automation. However, main()
can be called from
anywhere, and users can opt to not use main.R
at all.
Usage
main(project_path, silent = FALSE)
main(project_path, silent = FALSE)
Arguments
project_path |
A path to strata project folder. |
silent |
Suppress log messages? If |
Value
invisible execution plan.
.toml files
There are two types of .toml
files that main()
will read:
-
.strata.toml
- a singular file inside the<project_path>/strata
folder -
.laminae.toml
- a file inside each<project_path>/strata/<stratum_name>
folderThese files are created by the
strata
functions and are used to determine primarily the order of execution for the strata and laminae. Anything not referenced by a .toml will be ignored bymain()
and other functions such assurvey_strata()
,adhoc_stratum()
, andadhoc_lamina()
. Users can safely add other folders and files in the project root, and even within the subfolders and they will be ignored, unless users have code known by a.toml
that references them.Users can use the functions
survey_tomls()
and [view_toml())] to find and view the.toml
files in their project.
[view_toml())]: R:view_toml())
Examples
tmp <- fs::dir_create(fs::file_temp()) result <- strata::build_quick_strata_project(tmp, 1, 1) main(tmp) fs::dir_delete(tmp)
tmp <- fs::dir_create(fs::file_temp()) result <- strata::build_quick_strata_project(tmp, 1, 1) main(tmp) fs::dir_delete(tmp)