From c0910b2aa7147c1f4512cd751a1bfd20f0cfd770 Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Mon, 10 Jun 2024 22:38:23 +0800 Subject: [PATCH 1/6] Increment version number to 3.11.4.9000 --- DESCRIPTION | 2 +- NEWS.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index dd2e61d..ee3272d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: tarflow.iquizoo Title: Setup "targets" Workflows for "iquizoo" Data Processing -Version: 3.11.4 +Version: 3.11.4.9000 Authors@R: c( person("Liang", "Zhang", , "psychelzh@outlook.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9041-1150")), diff --git a/NEWS.md b/NEWS.md index d650952..6073cc3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,5 @@ +# tarflow.iquizoo (development version) + # tarflow.iquizoo 3.11.4 ## Breaking Changes From c01d539063898a87db1b72fdd08feefddaea9db1 Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Fri, 28 Jun 2024 20:11:12 +0800 Subject: [PATCH 2/6] Enhance documentation Signed-off-by: Liang Zhang --- R/targets.R | 6 +++--- man/tar_prep_iquizoo.Rd | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/R/targets.R b/R/targets.R index 37c9bb3..d15e0ad 100644 --- a/R/targets.R +++ b/R/targets.R @@ -16,9 +16,9 @@ #' @param ... For future usage. Should be empty. #' @param what What to fetch. There are basically two types of data, i.e., raw #' data and scores. The former is the logged raw data for each trial of the -#' tasks/games, while the latter is the scores calculated by iQuizoo server. -#' If set as "all", both raw data and scores will be fetched. Further actions -#' on the fetched raw data can be specified by `action_raw_data`. +#' tasks/games, and further actions on the fetched raw data can be specified +#' by `action_raw_data`. The latter is the scores calculated by iQuizoo +#' server. #' @param action_raw_data The action to be taken on the fetched raw data. There #' are two consecutive actions, i.e., wrangling and pre-processing. The former #' will parse the raw data into a tidy format, while the latter will calculate diff --git a/man/tar_prep_iquizoo.Rd b/man/tar_prep_iquizoo.Rd index 4d32985..8ed20b3 100644 --- a/man/tar_prep_iquizoo.Rd +++ b/man/tar_prep_iquizoo.Rd @@ -29,9 +29,9 @@ fetching. Note \code{contents} should at least contain \code{project_id} and \item{what}{What to fetch. There are basically two types of data, i.e., raw data and scores. The former is the logged raw data for each trial of the -tasks/games, while the latter is the scores calculated by iQuizoo server. -If set as "all", both raw data and scores will be fetched. Further actions -on the fetched raw data can be specified by \code{action_raw_data}.} +tasks/games, and further actions on the fetched raw data can be specified +by \code{action_raw_data}. The latter is the scores calculated by iQuizoo +server.} \item{action_raw_data}{The action to be taken on the fetched raw data. There are two consecutive actions, i.e., wrangling and pre-processing. The former From a55d8f3a53f870a5cc71738cf3f50a0aff6d275d Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Thu, 11 Jul 2024 15:18:53 +0800 Subject: [PATCH 3/6] Support light switch Signed-off-by: Liang Zhang --- _pkgdown.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/_pkgdown.yml b/_pkgdown.yml index f3e8a52..b2be592 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -1,6 +1,7 @@ url: https://psychelzh.github.io/tarflow.iquizoo template: bootstrap: 5 + light-switch: true reference: - title: "Targets Factory Related Functions" desc: "A collection of functions to help you build targets." From 826b7c7ba63a894f7b415ca5e5b960e5abca932a Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Thu, 11 Jul 2024 15:27:04 +0800 Subject: [PATCH 4/6] Enhance documentation Signed-off-by: Liang Zhang --- DESCRIPTION | 2 +- R/targets.R | 14 ++++++++------ man/tar_prep_iquizoo.Rd | 14 ++++++++------ 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index ee3272d..68f37ea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -49,4 +49,4 @@ Config/testthat/parallel: true Config/testthat/start-first: targets Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2 diff --git a/R/targets.R b/R/targets.R index d15e0ad..b9ed49e 100644 --- a/R/targets.R +++ b/R/targets.R @@ -20,12 +20,14 @@ #' by `action_raw_data`. The latter is the scores calculated by iQuizoo #' server. #' @param action_raw_data The action to be taken on the fetched raw data. There -#' are two consecutive actions, i.e., wrangling and pre-processing. The former -#' will parse the raw data into a tidy format, while the latter will calculate -#' indices based on the parsed data. If set as "all", both wrangling and -#' pre-processing will be done. If set as "parse", only wrangling will be -#' done. If set as "none", neither will be done. If `what` is "scores", this -#' argument will be ignored. +#' are two consecutive actions, i.e., raw data parsing and pre-processing. The +#' former will parse the `json` formatted raw data into [data.frame()]s and +#' wrap them into one list column, see [parse_data()] for more details. The +#' latter will calculate indices based on the parsed data, see +#' [preproc.iquizoo::preproc_data()] for more details. If set as `"none"`, +#' neither will be done. If set as `"parse"`, only raw data parsing will be +#' done. If set as `"all"`, both parsing and pre-processing will be done. If +#' `what` is set as `"scores"`, this argument will be ignored. #' @param combine Specify which targets to be combined. Note you should only #' specify names from `c("scores", "raw_data", "raw_data_parsed", "indices")`. #' If `NULL`, none will be combined. diff --git a/man/tar_prep_iquizoo.Rd b/man/tar_prep_iquizoo.Rd index 8ed20b3..b12c9e0 100644 --- a/man/tar_prep_iquizoo.Rd +++ b/man/tar_prep_iquizoo.Rd @@ -34,12 +34,14 @@ by \code{action_raw_data}. The latter is the scores calculated by iQuizoo server.} \item{action_raw_data}{The action to be taken on the fetched raw data. There -are two consecutive actions, i.e., wrangling and pre-processing. The former -will parse the raw data into a tidy format, while the latter will calculate -indices based on the parsed data. If set as "all", both wrangling and -pre-processing will be done. If set as "parse", only wrangling will be -done. If set as "none", neither will be done. If \code{what} is "scores", this -argument will be ignored.} +are two consecutive actions, i.e., raw data parsing and pre-processing. The +former will parse the \code{json} formatted raw data into \code{\link[=data.frame]{data.frame()}}s and +wrap them into one list column, see \code{\link[=parse_data]{parse_data()}} for more details. The +latter will calculate indices based on the parsed data, see +\code{\link[preproc.iquizoo:preproc_data]{preproc.iquizoo::preproc_data()}} for more details. If set as \code{"none"}, +neither will be done. If set as \code{"parse"}, only raw data parsing will be +done. If set as \code{"all"}, both parsing and pre-processing will be done. If +\code{what} is set as \code{"scores"}, this argument will be ignored.} \item{combine}{Specify which targets to be combined. Note you should only specify names from \code{c("scores", "raw_data", "raw_data_parsed", "indices")}. From 86af9cd17d33ea908db6b5865d32ff98893b0f93 Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Thu, 11 Jul 2024 15:27:42 +0800 Subject: [PATCH 5/6] Increment version number to 3.11.5 --- DESCRIPTION | 2 +- NEWS.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 68f37ea..9cb55f0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: tarflow.iquizoo Title: Setup "targets" Workflows for "iquizoo" Data Processing -Version: 3.11.4.9000 +Version: 3.11.5 Authors@R: c( person("Liang", "Zhang", , "psychelzh@outlook.com", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-9041-1150")), diff --git a/NEWS.md b/NEWS.md index 6073cc3..e1832d7 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# tarflow.iquizoo (development version) +# tarflow.iquizoo 3.11.5 # tarflow.iquizoo 3.11.4 From fc6d9c28cb22aebda4cc24f09e93ccef93e51492 Mon Sep 17 00:00:00 2001 From: Liang Zhang Date: Thu, 11 Jul 2024 15:28:52 +0800 Subject: [PATCH 6/6] NEWS bulletin Signed-off-by: Liang Zhang --- NEWS.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/NEWS.md b/NEWS.md index e1832d7..df4d34f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,5 +1,10 @@ # tarflow.iquizoo 3.11.5 +## Enhancements + +* Enhance documentation of `tar_prep_iquizoo()`. +* Support new dark theme of pkgdown. + # tarflow.iquizoo 3.11.4 ## Breaking Changes