Skip to content

Commit 474fb8d

Browse files
committed
fix roxygen warnings
1 parent 1049def commit 474fb8d

File tree

4 files changed

+15
-18
lines changed

4 files changed

+15
-18
lines changed

R/DataQualityFunctions.R

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,9 @@ initializeArray <- function(dqi, num_matrices, name_matrices) {
147147
return(dqi_3d)
148148
}
149149

150-
#' Creates D_dqi matrix from B_dqi using the formula
151-
#' (C %*% (B * B_dqi)) / D
150+
#' Creates D_dqi matrix from B_dqi
151+
#'
152+
#' Using the formula: (C \%*\% (B * B_dqi)) / D
152153
#' @param model A complete EEIO model object.
153154
#' @return A 3d matrix of dqi scores for D
154155
createDdqi <- function(model) {
@@ -165,8 +166,9 @@ createDdqi <- function(model) {
165166
return(dqi_3d)
166167
}
167168

168-
#' Creates M_dqi matrix from B_dqi using the formula
169-
#' ((B * B_dqi) %*% L) / M
169+
#' Creates M_dqi matrix from B_dqi
170+
#'
171+
#' Using the formula: ((B * B_dqi) \%*\% L) / M
170172
#' @param model A complete EEIO model object.
171173
#' @return A 3d matrix of dqi scores for M
172174
createMdqi <- function(model) {
@@ -183,8 +185,9 @@ createMdqi <- function(model) {
183185
return(dqi_3d)
184186
}
185187

186-
#' Creates N_dqi matrix from D_dqi using the formula
187-
#' ((D * D_dqi) %*% L) / N
188+
#' Creates N_dqi matrix from D_dqi
189+
#'
190+
#' Using the formula: ((D * D_dqi) \%*\% L) / N
188191
#' @param model A complete EEIO model object.
189192
#' @return A 3d matrix of dqi scores for N
190193
createNdqi <- function(model) {

man/createDdqi.Rd

Lines changed: 2 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/createMdqi.Rd

Lines changed: 2 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/createNdqi.Rd

Lines changed: 2 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)