v1.1

AgrDataSci · Nov 28, 2023 · fbc3a24 · fbc3a24
1 parent 69415b2
commit fbc3a24
Show file tree

Hide file tree

Showing 32 changed files with 210 additions and 75 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: ClimMobTools
 Type: Package
 Title: API Client for the 'ClimMob' Platform
-Version: 1.0
+Version: 1.1
 Authors@R: c(person("Kauê", "de Sousa", 
         email = "[email protected]", 
         role = c("aut", "cre"),
@@ -13,7 +13,7 @@ URL: https://agrdatasci.github.io/ClimMobTools/
 BugReports: https://github.com/agrdatasci/ClimMobTools/issues
 Description: API client for 'ClimMob', an open source software for decentralized 
     large-N trials with the 'tricot' approach <https://climmob.net/>. 
-    Developed by van Etten et al. (2016) <doi:10.1017/S0014479716000739>, it turns the 
+    Developed by Quiros et al. (2023) <doi:10.2139/ssrn.4463406>, it turns the 
     research paradigm on its head; instead of a few researchers designing complicated 
     trials to compare several technologies in search of the best solutions for the 
     target environment, it enables many participants to carry out reasonably simple 

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,10 @@
+ClimMobTools 1.1 (2023-11-28)
+=========================
+
+### BUG FIXES
+
+* Fix an issue in `.smart.round()` to handle `NA` in the `randomize()` function  
+
 ClimMobTools 1.0 (2023-11-10)
 =========================
 

diff --git a/R/AAA-getDataCM.R b/R/AAA-getDataCM.R
@@ -96,8 +96,3 @@ getDataCM <- function(key,
   return(cmdata)
 
 }
-
-
-
-
-
diff --git a/R/getProjectProgress.R b/R/getProjectProgress.R
@@ -120,4 +120,3 @@ getProjectProgress <- function(key, project, userowner, server = "climmob3"){
   return(r)
 
 }
-
diff --git a/R/getProjectsCM.R b/R/getProjectsCM.R
@@ -120,6 +120,3 @@ getProjectsCM <- function(key, server = "climmob3", ...){
   return(dat)
 
 }
-
-
-
diff --git a/R/internal_functions.R b/R/internal_functions.R
@@ -234,6 +234,3 @@
   return(ranks)
 
 }
-
-
-
diff --git a/R/randomize.R b/R/randomize.R
@@ -37,7 +37,38 @@
 #'           npackages = npackages,
 #'           itemnames = itemnames,
 #'           availability = availability)
-#'           
+#'
+#' @examplesIf interactive()           
+#' # run diagnostics to certify that randomization is balanced
+#' # the number of interactions should have the lower sd as possible
+#' # this verification may not work well when technologies are 
+#' # tested in different proportions
+#' design = randomize(ncomp = ncomp,
+#'                    npackages = npackages,
+#'                    itemnames = itemnames)
+#' 
+#' design$best = "A"
+#' 
+#' design$worst = "C"
+#' 
+#' # number of times each item is tested in the 
+#' # trial design
+#' ntest = table(unlist(design[,c(1:3)]))
+#' 
+#' ntest
+#' 
+#' # put into the PlackettLuce structure to check 
+#' # number of interactions between items 
+#' r = gosset::rank_tricot(design, c(1:3), c(4:5))
+#' 
+#' bn = gosset::set_binomialfreq(r)
+#' 
+#' bn$interactions = bn$win1 + bn$win2
+#' 
+#' bn = bn[,c(1,2,5)]
+#' 
+#' bn
+#' 
 #' @aliases randomise
 #' @importFrom Matrix Diagonal
 #' @importFrom methods as
@@ -503,13 +534,16 @@ makeAllocationsMatrix <- function(allocations){
   return(t(out))
 }
 
-# Rounding values to closest integer while retaining the same sum
-# From https://stackoverflow.com/questions/32544646/round-vector-of-numerics-to-integer-while-preserving-their-sum
+#' Rounding values to closest integer while retaining the same sum
+#' https://stackoverflow.com/questions/32544646/round-vector-of-numerics-to-integer-while-preserving-their-sum
+#' @examples 
+#' .smart.round(c(NA, 3.5, 7.8, 9, 10.4))
 #' @noRd
-.smart.round <- function(x) {
-  y <- floor(x)
-  indices <- utils::tail(order(x-y), round(sum(x)) - sum(y))
-  y[indices] <- y[indices] + 1
+.smart.round = function(x) {
+  x[is.na(x)] = 0
+  y = floor(x)
+  indices = utils::tail(order(x - y), round(sum(x)) - sum(y))
+  y[indices] = y[indices] + 1
   y
 }
 

diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ ClimMobTools
 
 ## Overview
 
-**ClimMobTools** the API Client for the 'ClimMob' platform in R. [ClimMob](https://climmob.net/) is an open source software for decentralized large-N trials with the 'tricot' approach. Developed by [van Etten et al. (2019)](https://doi.org/10.1017/S0014479716000739) 'tricot' turns the research paradigm on its head; instead of a few researchers designing complicated trials to compare several technologies in search of the best solutions, it enables many participants to carry out reasonably simple experiments that taken together can offer even more information.
+**ClimMobTools** the API Client for the 'ClimMob' platform in R. [ClimMob](https://climmob.net/) is an open source software for decentralized large-N trials with the 'tricot' approach. Developed by [Quiros et al. (2023)](http://dx.doi.org/10.2139/ssrn.4463406) 'tricot' turns the research paradigm on its head; instead of a few researchers designing complicated trials to compare several technologies in search of the best solutions, it enables many participants to carry out reasonably simple experiments that taken together can offer even more information.
 
 ## Package website
 

diff --git a/codemeta.json b/codemeta.json
@@ -2,12 +2,12 @@
   "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
   "@type": "SoftwareSourceCode",
   "identifier": "ClimMobTools",
-  "description": "API client for 'ClimMob', an open source software for decentralized large-N trials with the 'tricot' approach <https://climmob.net/>. Developed by van Etten et al. (2016) <doi:10.1017/S0014479716000739>, it turns the research paradigm on its head; instead of a few researchers designing complicated trials to compare several technologies in search of the best solutions for the target environment, it enables many participants to carry out reasonably simple experiments that taken together can offer even more information. 'ClimMobTools' enables project managers to deep explore and analyse their 'ClimMob' data in R.",
+  "description": "API client for 'ClimMob', an open source software for decentralized large-N trials with the 'tricot' approach <https://climmob.net/>. Developed by Quiros et al. (2023) <doi:10.2139/ssrn.4463406>, it turns the research paradigm on its head; instead of a few researchers designing complicated trials to compare several technologies in search of the best solutions for the target environment, it enables many participants to carry out reasonably simple experiments that taken together can offer even more information. 'ClimMobTools' enables project managers to deep explore and analyse their 'ClimMob' data in R.",
   "name": "ClimMobTools: API Client for the 'ClimMob' Platform",
   "codeRepository": "https://agrdatasci.github.io/ClimMobTools/",
   "issueTracker": "https://github.com/agrdatasci/ClimMobTools/issues",
   "license": "https://spdx.org/licenses/MIT",
-  "version": "1.0",
+  "version": "1.1",
   "programmingLanguage": {
     "@type": "ComputerLanguage",
     "name": "R",
@@ -232,7 +232,7 @@
     },
     "SystemRequirements": null
   },
-  "fileSize": "1248.669KB",
+  "fileSize": "1250.405KB",
   "citation": [
     {
       "@type": "ScholarlyArticle",

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html
diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html
diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html
diff --git a/docs/articles/Overview.html b/docs/articles/Overview.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,5 +3,5 @@ pkgdown: 2.0.6
 pkgdown_sha: ~
 articles:
   Overview: Overview.html
-last_built: 2023-11-09T19:32Z
+last_built: 2023-11-28T10:52Z
Original file line number	Diff line number	Diff line change
Expand Up		@@ -96,8 +96,3 @@ getDataCM <- function(key,
		return(cmdata)

		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -120,4 +120,3 @@ getProjectProgress <- function(key, project, userowner, server = "climmob3"){
		return(r)

		}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -120,6 +120,3 @@ getProjectsCM <- function(key, server = "climmob3", ...){
		return(dat)

		}