update documentation

- added cross-reference ppred_model, ppred_examples_df
- added documentation
- rbuildignore doesn't ignore vignette build and subsequently __pycache__ files

Author: i1es

.Rbuildignore

@@ -1,2 +1,4 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^\__pycache__$
+^process-prediction-workflow\.Rmd$

.gitignore

@@ -3,3 +3,5 @@
 .RData
 .Ruserdata
 inst/doc
+**__pycache__/
+*.py

R/ppred_examples_df.R

@@ -0,0 +1,6 @@
+#' @title ppred_examples_df object
+#' @name ppred_examples_df
+#' @docType class
+#' @description object of type [`ppred_examples_df`] is a transformed event log returned by `prepare_examples_dt()`.
+#'
+NULL

R/ppred_model.R

@@ -0,0 +1,6 @@
+#' @title ppred_model object
+#' @name ppred_model
+#' @docType class
+#' @description object of type [`ppred_model`] is a list returned by processpredictR::create_model() containing a custom keras functional (transformer) model and some other useful metrics of an event log.
+#'
+NULL

R/ppred_predictions.R

@@ -1,5 +1,5 @@
 #' @title ppred_predictions object
-#' @name predictions
+#' @name ppred_predictions
 #' @docType class
 #' @description object of type [`ppred_predictions`] is a data.frame with predicted values returned by predict.ppred_model().
 #'

man/ppred_examples_df.Rd

@@ -1,2 +1,4 @@
 *.html
 *.R
+**__pycache__/
+*.py