dbWork_report_completion: Estimate percentage of completed runs

Description Usage Arguments Value Examples

View source: R/WorkDatabase.R

Description

Estimate percentage of completed runs

Usage

1
2
3
4
5
dbWork_report_completion(
  path,
  use_granular_control = FALSE,
  SFSW2_prj_meta = NULL
)

Arguments

path

A character string. Path to the folder where the database will be created.

use_granular_control

A logical value. If TRUE and the granular table is present (see add_granular_dbWork), then calculate percentage of completed runs based on granular table instead of work table.

SFSW2_prj_meta

An environment. If use_granular_control, then required as well as presence of dbOutput.

Value

A numeric value in [0,100] in percent. The proportion of output units that are reported as complete.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
# `SFSW2_prj_meta` object as produced, e.g., for `TestPrj4`
if (exists("SFSW2_prj_meta")) {
  dbWork_report_completion(
    path = SFSW2_prj_meta[["project_paths"]][["dir_out"]],
    use_granular_control =
      SFSW2_prj_meta[["opt_out_fix"]][["use_granular_control"]],
    SFSW2_prj_meta = SFSW2_prj_meta)
}
## End(Not run)

Burke-Lauenroth-Lab/rSFSW2 documentation built on Aug. 14, 2020, 5:20 p.m.