Merge pull request #31 from metasurveyr/develop

Develop

R/set_engine.R

@@ -1,4 +1,5 @@
 #' @title set_engine
+#' @keywords engine
 #' @description Set engine for load survey
 #' @param .engine Character vector with the name of the engine
 #' @importFrom glue glue glue_col identity_transformer
@@ -54,6 +55,7 @@ set_engine <- function(.engine = show_engines()) {
 #' @description Show engines available
 #' @importFrom glue glue glue_col
 #' @export
+#' @keywords engine
 #' @return Character vector
 
 show_engines <- function() {

R/steps.R

@@ -93,6 +93,7 @@ recode <- function(svy, new_var, ..., .default = NA_character_, ordered = FALSE,
 #' @param ... Expressions to compute
 #' @param use_copy Use copy
 #' @return Survey object
+#' @keywords Steps
 #' @export
 
 step_compute <- function(svy = NULL, ..., use_copy = use_copy_default()) {
@@ -206,6 +207,7 @@ step_compute <- function(svy = NULL, ..., use_copy = use_copy_default()) {
 #' @param ordered Ordered
 #' @param use_copy Use copy
 #' @return Survey object
+#' @keywords Steps
 #' @export
 
 step_recode <- function(svy = survey_empty(), new_var, ..., .default = NA_character_, .name_step = NULL, ordered = FALSE, use_copy = use_copy_default()) {
@@ -347,6 +349,8 @@ get_type_step <- function(steps) {
 #' @importFrom visNetwork visOptions
 #' @importFrom visNetwork addFontAwesome
 #' @return Graph
+#' @keywords Survey methods
+#' @keywords Steps
 #' @export
 
 

R/survey.R

@@ -56,27 +56,33 @@ Survey <- R6Class("Survey",
 
 #' @title survey_to_data_frame
 #' @description Convert survey to data.frame
+#' @keywords Surveymethods
 #' @param svy Survey object
+
 #' @export
 #' @return data.frame
 survey_to_data_frame <- function(svy) {
   data.frame(svy$get_data())
 }
 
 #' @title survey_to_tibble
+#' @keywords Surveymethods
 #' @description Convert survey to tibble
 #' @param svy Survey object
 #' @export
 #' @return tibble
 
+
 survey_to_tibble <- function(svy) {
   tibble::as_tibble(svy$get_data())
 }
 
 #' @title survey_to_data.table
+#' @keywords Surveymethods
 #' @description Convert survey to data.table
 #' @param svy Survey object
 #' @export
+
 #' @importFrom data.table data.table
 #' @return data.table
 #' 
@@ -88,6 +94,7 @@ survey_to_data.table <- function(svy) {
 #' @title get_data
 #' @description Get data from survey
 #' @param svy Survey object
+#' @keywords Surveymethods
 #' @export
 #' @return Data
 #' 
@@ -138,6 +145,7 @@ set_weight <- function(svy, new_weight) {
 
 #' @title get_metadata
 #' @description Get metadata from survey
+#' @keywords Surveymethods
 #' @importFrom glue glue glue_col
 #' @importFrom emoji emoji
 #' @param self Object of class Survey
@@ -183,6 +191,8 @@ get_metadata <- function(self) {
 #' @title get_steps
 #' @description Get steps from survey
 #' @param svy Survey object
+#' @keywords Survey methods
+#' @keywords Steps
 #' @export
 #' @return List
 
@@ -192,11 +202,13 @@ get_steps <- function(svy) {
 
 #' @title survey_empty
 #' @description Create an empty survey
+#' @keywords Surveymethods
 #' @param edition Edition of survey
 #' @param type Type of survey
 #' @param weight Weight of survey
 #' @param engine Engine of survey
 #' @export
+
 #' @return Survey object
 #' 
 

R/utils.R

@@ -37,6 +37,7 @@ validate_weight <- function(svy, weight) {
 
 #' Load survey example
 #' @param path Path to the survey file
+#' @keywords utils
 #' @export
 
 load_survey_example <- function(path = NULL) {
@@ -49,6 +50,7 @@ load_survey_example <- function(path = NULL) {
 
 #' Get use_copy option
 #' @return Use copy
+#' @keywords utils
 #' @export
 
 use_copy_default <- function() {
@@ -58,6 +60,7 @@ use_copy_default <- function() {
 #' Set use_copy option
 #' @param use_copy Use copy
 #' @export
+#' @keywords utils
 #' @examples
 #' set_use_copy(FALSE)
 #' use_copy_default()

_pkgdown.yml

@@ -28,3 +28,19 @@ authors:
   Natalia da Silva:
     href: https://iesta.fcea.udelar.edu.uy/integrantes/natalia-da-silva/
 
+reference:
+- title: Engine
+  contents:
+    - has_keyword("engine")
+- title: Survey methods
+  contents:
+    - has_keyword("Surveymethods")
+- title: Steps
+  contents:
+    - has_keyword("Steps")
+- title: Preprocessing
+  contents:
+    - has_keyword("preprocessing")
+- title: Utils
+  contents:
+    - has_keyword("utils")