diff --git a/_pkgdown.yml b/_pkgdown.yml index c09e02c..e57377b 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -24,6 +24,7 @@ reference: contents: - rren_example - rren_artificial + - report_summaries - title: internal contents: diff --git a/docs/404.html b/docs/404.html index af74806..29e3f7d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -24,7 +24,7 @@ rren - 0.0.5 + 0.0.7 + + + + + +
+
+
+

Compute flat percentile bootstrap confidence interval.

+ Source: R/interval.R +
compute_flat_percentile_ci.Rd
+
+ +
+

Uses compute_vector_flat_percentile_ci() to compute percentile confidence interval on data that is not structured into runs.

+
+ +
+

Usage

+ 
compute_flat_percentile_ci(.input, .column, ...)
+
+ +
+

Arguments

+
.input
+

Data not structured into runs.

+ + +
.column
+

Column to compute confidence interval for.

+ + +
...
+

Parameters to compute_vector_flat_percentile_ci().

+ +
+
+

Value

+ + +

Summarized tibble with confidence interval columns.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/compute_flat_percentile_cis.html b/docs/reference/compute_flat_percentile_cis.html deleted file mode 100644 index ec4b819..0000000 --- a/docs/reference/compute_flat_percentile_cis.html +++ /dev/null @@ -1,108 +0,0 @@ - -Compute flat percentile bootstrap confidence interval. — compute_flat_percentile_cis • rren - Skip to contents - - -
-
-
-

Compute flat percentile bootstrap confidence interval.

- Source: R/interval.R -
compute_flat_percentile_cis.Rd
-
- -
-

Uses bootstrap to compute percentile confidence interval on data summarized across runs.

-
- -
-

Usage

- 
compute_flat_percentile_cis(
-  .input,
-  .column,
-  .statistic = mean,
-  .confidence = 0.99,
-  .R = 10000
-)
-
- -
-

Arguments

-
.input
-

Data summarized across runs.

- - -
.column
-

Column to compute confidence interval for.

- - -
.statistic
-

Statistic to compute confidence interval for.

- - -
.confidence
-

Confidence level.

- - -
.R
-

Replicates.

- -
-
-

Value

- - -

Summarized tibble with confidence interval columns.

-
- -
- - -
- - - - - - - diff --git a/docs/reference/compute_flat_percentile_cis_group_helper.html b/docs/reference/compute_hierarchical_percentile_ci.html similarity index 77% rename from docs/reference/compute_flat_percentile_cis_group_helper.html rename to docs/reference/compute_hierarchical_percentile_ci.html index c1d6644..3f85bd6 100644 --- a/docs/reference/compute_flat_percentile_cis_group_helper.html +++ b/docs/reference/compute_hierarchical_percentile_ci.html @@ -1,5 +1,5 @@ -Group helper for flat percentile bootstrap confidence interval. — compute_flat_percentile_cis_group_helper • rrenCompute hierarchical percentile bootstrap confidence interval. — compute_hierarchical_percentile_ci • rren @@ -10,7 +10,7 @@ rren - 0.0.5 + 0.0.7 + + + + + +
+
+
+

Compute hierarchical percentile bootstrap confidence interval.

+ Source: R/interval.R +
compute_list_vectors_hierarchical_percentile_ci.Rd
+
+ +
+

Compute hierarchical percentile bootstrap confidence interval.

+
+ +
+

Usage

+ 
compute_list_vectors_hierarchical_percentile_ci(
+  .input,
+  .statistic_outer = mean,
+  .statistic_inner = mean,
+  .confidence = 0.99,
+  .R = 10000
+)
+
+ +
+

Arguments

+
.input
+

Data to compute confidence interval for.

+ + +
.statistic_outer
+

Statistic to apply at the outer level.

+ + +
.statistic_inner
+

Statistic to apply at the inner leve.

+ + +
.confidence
+

Confidence level.

+ + +
.R
+

Number of replicates.

+ +
+
+

Value

+ + +

Tibble with confidence interval.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/compute_trends.html b/docs/reference/compute_trends.html index 27c2628..8025bbd 100644 --- a/docs/reference/compute_trends.html +++ b/docs/reference/compute_trends.html @@ -10,7 +10,7 @@ rren - 0.0.5 + 0.0.7 + + + + + +
+
+
+

Compute flat percentile bootstrap confidence interval.

+ Source: R/interval.R +
compute_vector_flat_percentile_ci.Rd
+
+ +
+

Compute flat percentile bootstrap confidence interval.

+
+ +
+

Usage

+ 
compute_vector_flat_percentile_ci(
+  .input,
+  .statistic = mean,
+  .confidence = 0.99,
+  .R = 10000
+)
+
+ +
+

Arguments

+
.input
+

Data to compute confidence interval for.

+ + +
.statistic
+

Statistic to compute confidence interval for.

+ + +
.confidence
+

Confidence level.

+ + +
.R
+

Number of replicates.

+ +
+
+

Value

+ + +

Tibble with confidence interval.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/expect_renaissance.html b/docs/reference/expect_renaissance.html index b7f39d8..4f06559 100644 --- a/docs/reference/expect_renaissance.html +++ b/docs/reference/expect_renaissance.html @@ -10,7 +10,7 @@ rren - 0.0.5 + 0.0.7 + + + + + +
+
+
+

Flag outliers.

+ Source: R/filter.R +
flag_outliers_global.Rd
+
+ +
+

Uses identify_vector_outliers_global() to identify outliers in given column. Then, flags the outlier rows.

+
+ +
+

Usage

+ 
flag_outliers_global(.input, .column, .flag, ...)
+
+ +
+

Arguments

+
.input
+

Data.

+ + +
.column
+

Column to identify outliers in.

+ + +
.flag
+

Column to use as flag.

+ + +
...
+

Parameters to identify_vector_outliers_global().

+ +
+
+

Value

+ + +

Tibble with new flag column.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/flag_outliers_window.html b/docs/reference/flag_outliers_window.html new file mode 100644 index 0000000..28bc2de --- /dev/null +++ b/docs/reference/flag_outliers_window.html @@ -0,0 +1,98 @@ + +Flag outliers using sliding window. — flag_outliers_window • rren + Skip to contents + + +
+
+
+

Flag outliers using sliding window.

+ Source: R/filter.R +
flag_outliers_window.Rd
+
+ +
+

Uses identify_vector_outliers_window() to identify outliers in given column. Then, flags the outlier rows.

+
+ +
+

Usage

+ 
flag_outliers_window(.input, .column, .flag, ...)
+
+ +
+

Arguments

+
.input
+

Data.

+ + +
.column
+

Column to identify outliers in.

+ + +
.flag
+

Column to use as flag.

+ + +
...
+

Parameters to identify_vector_outliers_window().

+ +
+
+

Value

+ + +

Tibble with new flag column.

+
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/identify_vector_outliers_global.html b/docs/reference/identify_vector_outliers_global.html index f5a03d8..ebd3c7c 100644 --- a/docs/reference/identify_vector_outliers_global.html +++ b/docs/reference/identify_vector_outliers_global.html @@ -16,7 +16,7 @@ rren - 0.0.5 + 0.0.7 + + + + + +
+
+
+

Report result summaries.

+ Source: R/report.R +
report_summaries.Rd
+
+ +
+

Generates result summaries for human consumption.

+
+ +
+

Usage

+ 
report_summaries(input = ".", warmup = 5 * 60)
+
+ +
+

Arguments

+
input
+

Data path or data tibble to summarize.

+ + +
warmup
+

Duration to discard as warm up time.

+ +
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/report_summaries_benchmark_group_helper.html b/docs/reference/report_summaries_benchmark_group_helper.html new file mode 100644 index 0000000..ab174d8 --- /dev/null +++ b/docs/reference/report_summaries_benchmark_group_helper.html @@ -0,0 +1,84 @@ + +Group helper for report result summaries. — report_summaries_benchmark_group_helper • rren + Skip to contents + + +
+
+
+

Group helper for report result summaries.

+ Source: R/report.R +
report_summaries_benchmark_group_helper.Rd
+
+ +
+

Group helper for report result summaries.

+
+ +
+

Usage

+ 
report_summaries_benchmark_group_helper(group, key)
+
+ +
+

Arguments

+
group
+

Single benchmark group to report on.

+ + +
key
+

Group key information.

+ +
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/report_summaries_vm_group_helper.html b/docs/reference/report_summaries_vm_group_helper.html new file mode 100644 index 0000000..af9a958 --- /dev/null +++ b/docs/reference/report_summaries_vm_group_helper.html @@ -0,0 +1,84 @@ + +Group helper for report result summaries. — report_summaries_vm_group_helper • rren + Skip to contents + + +
+
+
+

Group helper for report result summaries.

+ Source: R/report.R +
report_summaries_vm_group_helper.Rd
+
+ +
+

Group helper for report result summaries.

+
+ +
+

Usage

+ 
report_summaries_vm_group_helper(group, key)
+
+ +
+

Arguments

+
group
+

Single virtual machine group to report on.

+ + +
key
+

Group key information.

+ +
+ +
+ + +
+ + + + + + + diff --git a/docs/reference/rren-package.html b/docs/reference/rren-package.html index d3ec732..c8b303c 100644 --- a/docs/reference/rren-package.html +++ b/docs/reference/rren-package.html @@ -10,7 +10,7 @@ rren - 0.0.5 + 0.0.7