Skip to content

Commit 8435cbe

Browse files
committed
remove force option for non-ordered and update documentation
1 parent e5e83dc commit 8435cbe

26 files changed

+77
-69
lines changed

R/bgsd.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' @param pop The number of people within each subgroup.
2828
#' Population size must be available for all subgroups.
2929
#' @param est The subgroup estimate. Estimates must be
30-
#' available for at least 85% of subgroups, unless force=TRUE.
30+
#' available for at least 85% of subgroups.
3131
#' @param se The standard error of the subgroup estimate.
3232
#' If this is missing, 95% confidence intervals of BGSD cannot be calculated.
3333
#' @param scaleval The scale of the indicator. For example, the

R/bgv.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' @param pop The number of people within each subgroup.
2929
#' Population size must be available for all subgroups.
3030
#' @param est The subgroup estimate. Estimates must be
31-
#' available at least 85% of subgroups, unless force=TRUE.
31+
#' available at least 85% of subgroups.
3232
#' @param se The standard error of the subgroup estimate.
3333
#' If this is missing, confidence intervals of BGV cannot be calculated.
3434
#' @param conf.level Confidence level of the interval. Default is 0.95 (95%).

R/covar.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#' @param pop The number of people within each subgroup.
3030
#' Population size must be available for all subgroups.
3131
#' @param est The subgroup estimate. Estimates must be
32-
#' available for at least 85% of subgroups, unless force=TRUE.
32+
#' available for at least 85% of subgroups.
3333
#' @param se The standard error of the subgroup estimate.
3434
#' If this is missing, 95% confidence intervals of COV cannot be calculated.
3535
#' @param scaleval The scale of the indicator. For example, the

R/idisu.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' @param pop The number of people within each subgroup.
2929
#' Population size must be available for all subgroups.
3030
#' @param est The subgroup estimate.
31-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
31+
#' Estimates must be available for at least 85% of subgroups.
3232
#' @param se The standard error of the subgroup estimate.
3333
#' If this is missing, 95% confidence intervals of IDISU cannot be calculated.
3434
#' @param scaleval The scale of the indicator. For example, the

R/idisw.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#' @param pop The number of people within each subgroup.
3030
#' Population size must be available for all subgroups.
3131
#' @param est The subgroup estimate.
32-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
32+
#' Estimates must be available for at least 85% of subgroups.
3333
#' @param se The standard error of the subgroup estimate.
3434
#' If this is missing, 95% confidence intervals of IDISW cannot be calculated.
3535
#' @param scaleval The scale of the indicator. For example, the

R/mdbu.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
#' **Applicability:** Non-ordered; more than two subgroups
2727
#'
2828
#' @param est The subgroup estimate.
29-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
29+
#' Estimates must be available for at least 85% of subgroups.
3030
#' @param se The standard error of the subgroup estimate.
3131
#' If this is missing, 95% confidence intervals of MDBU cannot be calculated.
3232
#' @param scaleval The scale of the indicator. For example, the

R/mdbw.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' @param pop The number of people within each subgroup.
2929
#' Population size must be available for all subgroups.
3030
#' @param est The subgroup estimate.
31-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
31+
#' Estimates must be available for at least 85% of subgroups.
3232
#' @param se The standard error of the subgroup estimate.
3333
#' If this is missing, 95% confidence intervals of MDBW cannot be calculated.
3434
#' @param scaleval The scale of the indicator. For example, the

R/mdmu.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' @param pop The number of people within each subgroup.
2828
#' Population size must be available for all subgroups.
2929
#' @param est The subgroup estimate.
30-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
30+
#' Estimates must be available for at least 85% of subgroups.
3131
#' @param se The standard error of the subgroup estimate.
3232
#' If this is missing, 95% confidence intervals of MDMU cannot be calculated.
3333
#' @param scaleval The scale of the indicator. For example, the

R/mdmw.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
#' @param pop The number of people within each subgroup.
2929
#' Population size must be available for all subgroups.
3030
#' @param est The subgroup estimate.
31-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
31+
#' Estimates must be available for at least 85% of subgroups.
3232
#' @param se The standard error of the subgroup estimate.
3333
#' If this is missing, 95% confidence intervals of MDMW cannot be calculated.
3434
#' @param scaleval The scale of the indicator. For example, the

R/mdru.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
#' **Applicability:** Non-ordered; more than two subgroups
2727
#'
2828
#' @param est The subgroup estimate.
29-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
29+
#' Estimates must be available for at least 85% of subgroups.
3030
#' @param se The standard error of the subgroup estimate.
3131
#' If this is missing, 95% confidence intervals of MDRU cannot be calculated.
3232
#' @param scaleval The scale of the indicator. For example, the

R/mdrw.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' @param pop The number of people within each subgroup.
2828
#' Population size must be available for all subgroups.
2929
#' @param est The subgroup estimate.
30-
#' Estimates must be available for at least 85% of subgroups, unless force=TRUE.
30+
#' Estimates must be available for at least 85% of subgroups.
3131
#' @param se The standard error of the subgroup estimate.
3232
#' If this is missing, 95% confidence intervals of MDRW cannot be calculated.
3333
#' @param scaleval The scale of the indicator. For example, the

R/mld.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
#' @param pop The number of people within each subgroup.
2727
#' Population size must be available for all subgroups.
2828
#' @param est The subgroup estimate. Estimates must be
29-
#' available for at least 85% of subgroups, unless force=TRUE.
29+
#' available for at least 85% of subgroups.
3030
#' @param se The standard error of the subgroup estimate.
3131
#' If this is missing, confidence intervals of MLD cannot be calculated.
3232
#' @param conf.level Confidence level of the interval. Default is 0.95 (95%).

R/ti.R

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
#' @param pop The number of people within each subgroup.
2828
#' Population size must be available for all subgroups.
2929
#' @param est The subgroup estimate. Estimates must be
30-
#' available for at least 85% of subgroups, unless force=TRUE.
30+
#' available for at least 85% of subgroups.
3131
#' @param se The standard error of the subgroup estimate.
3232
#' If this is missing, confidence intervals of TI cannot be calculated.
3333
#' @param conf.level Confidence level of the interval. Default is 0.95 (95%).

man/bgsd.Rd

+5-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/bgv.Rd

+7-8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/covar.Rd

+5-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/idisu.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/idisw.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdbu.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdbw.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdmu.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdmw.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdru.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mdrw.Rd

+4-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)