1. Creating vignette for additional parameters

2. Change description of functions regarding to that
3. Change function parameter sorting according to the new file
4. Change tests for sortcriterion if necessary dependent of the changes under point 3

Author: KovaZo

R/gen_alternative_terms.R

@@ -1,10 +1,10 @@
-#' gen_alternative_terms: Call for similiar or spelling related terms for further search
+#' gen_alternative_terms: Call For Similiar or Spelling Related Terms for Further Search
 #'
 #' @description Function to find search terms that are similar or related to one another and also represented in Genesis.
 #'
 #' @param term Character string. Maximum length of 15 characters. Term or word for which you are searching for alternative or related terms. Use of '*' as a placeholder is possible to generate broader search areas.
 #' @param similarity Logical. Indicator if the output of the function should be sorted based on a Levenshtein edit distance based on the \code{adist()} function.
-#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the data.frame, describing the search configuration for the returned output.
 #' @export

R/gen_catalogue.R

@@ -5,9 +5,8 @@
 #' @param code a string with a maximum length of 10 characters. Code from a Genesis-Object. Only one code per iteration. "*"-Notations are possible.
 #' @param category a string. Specific Genesis-Object-types: 'tables', 'statistics', and 'cubes'. All three together are possible.
 #' @param detailed a logical. Indicator if the function should return the detailed output of the iteration including all object-related information or only a shortened output including only code and object title.
-#' @param sortcriterion a string. Indicator if the output should be sorted by 'code' or 'content'. This is a parameter of the Genesis API call itself.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis API. Based on the detailed-parameter it contains more or less information, but always includes the code of the object, the title, and the type of the object. This is done to facilitate further processing with the data. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -27,7 +26,6 @@
 gen_catalogue <- function(code = NULL,
                           category = c("tables", "statistics", "cubes"),
                           detailed = FALSE,
-                          sortcriterion = c("code", "content"),
                           error.ignore = FALSE,
                           ...) {
 
@@ -36,11 +34,9 @@ gen_catalogue <- function(code = NULL,
   check_function_input(code = code,
                        category = category,
                        detailed = detailed,
-                       sortcriterion = sortcriterion,
                        error.ignore = error.ignore,
                        caller = caller)
 
-  sortcriterion <- match.arg(sortcriterion)
 
   #-----------------------------------------------------------------------------
 
@@ -103,7 +99,6 @@ gen_catalogue <- function(code = NULL,
                     username = gen_auth_get()$username,
                     password = gen_auth_get()$password,
                     selection = code,
-                    sortcriterion = sortcriterion,
                     ...)
 
     results_json <- test_if_json(results_raw)
@@ -156,7 +151,6 @@ gen_catalogue <- function(code = NULL,
                     username = gen_auth_get()$username,
                     password = gen_auth_get()$password,
                     selection = code,
-                    sortcriterion = sortcriterion,
                     ...)
 
     results_json <- test_if_json(results_raw)

R/gen_find.R

@@ -9,7 +9,7 @@
 #' @param detailed A logical. Indicator if the function should return the detailed output of the iteration including all object related information or only a shortened output including only code and object title. Default Option is FALSE.
 #' @param ordering A logical. Indicator if the function should return the output of the iteration ordered first based on the fact if the searched term is appearing in the title of the object and secondly on an estimator of the number of variables in this object. Default option is TRUE.
 #' @param error.ignore  A logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce an artificial response (e.g., for complex processes not to fail).
-#' @param ... Additional parameters of the Genesis API call. These parameters are only affecting the Genesis API call itself, there is no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all elements retrieved from Genesis. Attributes are added to the data.frame describing the search configuration for the returned output.
 #' @export

R/gen_list_jobs.R

@@ -4,7 +4,7 @@
 #'
 #' @param selection Filter the list of jobs for matching codes.
 #' @param sortcriterion Allows to sort the resulting list of jobs by their Code ("content"), the time of completion ("time") or status ("status")
-#' @param ... Further parameters to be passed down to the API caller.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list of all current jobs connected to the given user.
 #' @export

R/gen_meta_data.R

@@ -4,7 +4,7 @@
 #'
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -73,7 +73,7 @@ gen_metadata_stats <- function(code = NULL,
 #'
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration. "*"-Notation is possible.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -143,7 +143,7 @@ gen_metadata_var <- function(code = NULL,
 #'
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -210,7 +210,7 @@ gen_metadata_val <- function(code = NULL,
 #'
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -354,7 +354,7 @@ gen_metadata_tab <- function(code = NULL,
 #'
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -477,7 +477,7 @@ gen_metadata_cube <- function(code = NULL,
 #' @param code string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param category a string. Specific object-types: 'Cube', 'Statistic', "Table", "Variable" and 'Value'. The function needs a specified object type.
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export

R/gen_modified_data.R

@@ -5,7 +5,7 @@
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis object. Only one code per iteration. "*" notations are possible. Empty code (default value) includes all changes, updates, and new added objects.
 #' @param type a string. Specific Genesis object type: 'tables', 'statistics', and 'statisticsUpdates'. All three can be accessed through "all", which is the default.
 #' @param date a string. Specific date that is used as the last update or upload time in Genesis to include a Genesis object in return. Default option is 'now', which uses the current date of your system. Alternative options are 'week_before', using the current date of your system minus 7 days, 'month_before', using the current date of your system minus 4 weeks, and 'year_before', using the current date of your system minus 52 weeks. Additionally, it is possible to fill in a specific date of format 'DD.MM.YYYY'.
-#' @param ... Additional parameters for the Genesis call. These parameters are only affecting the Genesis call itself, not the further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Always includes the code of the object, the title, and the type of the object. This is done to facilitate further processing with the data. Attributes are added to the data.frame describing the search configuration for the returned output.
 #' @export

R/gen_objects2stat.R

@@ -5,9 +5,8 @@
 #' @param code a string with a maximum length of 6 characters (15 characters if cubes are not used as a category). Code from a Genesis-Object. Only one code per iteration.
 #' @param category a string. Specific object-types: 'tables', 'variables', and 'cubes'. All three together are possible and the default option.
 #' @param detailed a logical. Indicator if function should return the detailed output of the iteration including all object-related information or only a shortened output including only code and object title. The default is detailed = FALSE.
-#' @param sortcriterion a string. Indicator if the output should be sorted by 'code' or 'content'. This is a parameter of the Genesis API call itself. The default is "code".
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis Based on the detailed-parameter it contains more or less information, but always includes the code of the object, the title, and the type of the object. This is done to facilitate further processing of the data. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -26,7 +25,6 @@
 gen_objects2stat <- function(code = NULL,
                              category = c("tables", "variables", "cubes"),
                              detailed = FALSE,
-                             sortcriterion = c("code", "content"),
                              error.ignore = FALSE,
                              ...) {
 
@@ -35,12 +33,9 @@ gen_objects2stat <- function(code = NULL,
   check_function_input(code = code,
                        category = category,
                        detailed = detailed,
-                       sortcriterion = sortcriterion,
                        error.ignore = error.ignore,
                        caller = caller)
 
-  sortcriterion <- match.arg(sortcriterion)
-
   #-------------------------------------------------------------------------------
 
   if ("tables" %in% category) {
@@ -49,7 +44,6 @@ gen_objects2stat <- function(code = NULL,
                               username = gen_auth_get()$username,
                               password = gen_auth_get()$password,
                               name = code,
-                              sortcriterion = sortcriterion,
                               ...)
 
       results_json <- test_if_json(results_raw)
@@ -94,7 +88,6 @@ gen_objects2stat <- function(code = NULL,
                             username = gen_auth_get()$username,
                             password = gen_auth_get()$password,
                             name = code,
-                            sortcriterion = sortcriterion,
                             ...)
 
     results_json <- test_if_json(results_raw)

R/gen_objects2var.R

@@ -5,9 +5,8 @@
 #' @param code a string with a maximum length of 15 characters. Code from a Genesis-Object. Only one code per iteration.
 #' @param category a string. Specific object-types: 'tables', 'statistics', and 'cubes'. All three together are possible and the default option.
 #' @param detailed a logical. Indicator if function should return the detailed output of the iteration including all object-related information or only a shortened output including only code and object title. The default is detailed = FALSE.
-#' @param sortcriterion a string. Indicator if the output should be sorted by 'code' or 'content'. This is a parameter of the Genesis API call itself. The default is "code".
 #' @param error.ignore  a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
-#' @param ... Additional parameter of the Genesis API call. These parameters are only affecting the Genesis API call itself, no further processing.
+#' @param ... Additional parameters for the Genesis API call. These parameters are only affecting the Genesis call itself, no further processing. For more details see `vignette("additional_parameter")`.
 #'
 #' @return A list with all recalled elements from Genesis. Based on the detailed-parameter it contains more or less information, but always includes the code of the object, the title, and the type of the object. This is done to facilitate further processing of the data. Attributes are added to the dataframe describing the search configuration for the returned output.
 #' @export
@@ -26,7 +25,6 @@
 gen_objects2var <- function(code = NULL,
                             category = c("tables", "statistics", "cubes"),
                             detailed = FALSE,
-                            sortcriterion = c("code", "content"),
                             error.ignore = FALSE,
                             ...) {
 
@@ -36,11 +34,8 @@ gen_objects2var <- function(code = NULL,
                        category = category,
                        detailed = detailed,
                        error.ignore = error.ignore,
-                       sortcriterion = sortcriterion,
                        caller = caller)
 
-  sortcriterion <- match.arg(sortcriterion)
-
   #-----------------------------------------------------------------------------
 
   if ("tables" %in% category) {
@@ -49,7 +44,6 @@ gen_objects2var <- function(code = NULL,
                             username = gen_auth_get()$username,
                             password = gen_auth_get()$password,
                             name = code,
-                            sortcriterion = sortcriterion,
                             ...)
 
     results_json <- test_if_json(results_raw)
@@ -96,7 +90,6 @@ gen_objects2var <- function(code = NULL,
                             username = gen_auth_get()$username,
                             password = gen_auth_get()$password,
                             name = code,
-                            sortcriterion = sortcriterion,
                             ...)
 
     results_json <- test_if_json(results_raw)