Modifications exemples et doc

DESCRIPTION

@@ -17,5 +17,6 @@ Imports:
     fst,
     haven,
     purrr,
-    rlang
+    rlang,
+    Hmisc
 Roxygen: list(markdown = TRUE)

R/contrastes.R

@@ -38,6 +38,9 @@ contr_treatment_perso <- function (n,
 
 #' Contrastes de traitement plus jolis
 #'
+#' Contrastes de traitement plus jolis. Voir [stats::contr.treatment()] pour plus
+#' d'informations.
+#'
 #' @param decorate.contrasts un vecteur contenant deux chaînes de caractères,
 #' placées au début et à la fin du nom de la variable
 #' @param decorate.contr.Treatment une chaîne de caractères placée au début
@@ -70,4 +73,7 @@ generer_contr_treatment_perso <- function(decorate.contrasts = NULL, decorate.co
 
 #' @describeIn generer_contr_treatment_perso contraste de la forme
 #' \code{"variable = modalite"}
-ct_perso <- generer_contr_treatment_perso(c(" ", ""), "= ")
+#' @inheritParams stats::contr.treatment
+ct_perso <- function(n, base = 1, contrasts = TRUE, sparse = FALSE) {
+  generer_contr_treatment_perso(c(" ", ""), "= ")(n, base, contrasts, sparse)
+}

R/sas_to_fst.R

@@ -13,9 +13,7 @@
 #' @encoding UTF-8
 #'
 #' @examples
-#' \dontrun{
-#' sas_to_fst("~/Documents/tables_sas", "~/Documents/tables_fst")
-#' }
+#' \dontrun{sas_to_fst("~/Documents/tables_sas", "~/Documents/tables_fst")}
 sas_to_fst <- function(dossier_entree, dossier_sortie = NULL) {
   if (is.null(dossier_sortie)) dossier_sortie <- dossier_entree
 

R/transformation_variables.R

@@ -49,7 +49,7 @@ cut_french <- function(x, int.breaks, right = TRUE, ...) {
 #'
 #' @examples
 #' x <- 1:50
-#' case_when(
+#' case_when_factor(
 #'   x %% 35 == 0 ~ "fizz buzz",
 #'   x %% 5 == 0 ~ "fizz",
 #'   x %% 7 == 0 ~ "buzz",
@@ -74,8 +74,8 @@ case_when_factor <- function(...) {
 #' @return Un vecteur discrétisé selon des quantiles pondérés.
 #' @export
 #'
-weighted_ntile <- function(x, w, n, french = FALSE) {
-  quantiles <- Hmisc::wtd.quantile(x, w, probs = (1:(n-1))/n, ...)
+weighted_ntile <- function(x, w, n, french = FALSE, ...) {
+  quantiles <- Hmisc::wtd.quantile(x, w, probs = (1:(n-1))/n)
   if (french) {
     cut_french(x, int.breaks=quantiles, labels = FALSE, ...)
   } else cut(x, c(-Inf, quantiles, Inf), labels = FALSE, ...)

man/case_when_factor.Rd

@@ -23,7 +23,7 @@ spécifiés dans les conditions.
 }
 \examples{
 x <- 1:50
-case_when(
+case_when_factor(
   x \%\% 35 == 0 ~ "fizz buzz",
   x \%\% 5 == 0 ~ "fizz",
   x \%\% 7 == 0 ~ "buzz",

man/generer_contr_treatment_perso.Rd

@@ -10,7 +10,7 @@ generer_contr_treatment_perso(
   decorate.contr.Treatment = NULL
 )
 
-ct_perso(...)
+ct_perso(n, base = 1, contrasts = TRUE, sparse = FALSE)
 }
 \arguments{
 \item{decorate.contrasts}{un vecteur contenant deux chaînes de caractères,
@@ -18,6 +18,18 @@ placées au début et à la fin du nom de la variable}
 
 \item{decorate.contr.Treatment}{une chaîne de caractères placée au début
 du nom de la modalité}
+
+\item{n}{a vector of levels for a factor, or the number of levels.}
+
+\item{base}{an integer specifying which group is considered the
+    baseline group. Ignored if \code{contrasts} is \code{FALSE}.}
+
+\item{contrasts}{a logical indicating whether contrasts should be
+    computed.}
+
+\item{sparse}{logical indicating if the result should be sparse
+    (of class \code{\link[Matrix:dgCMatrix-class]{dgCMatrix}}), using
+    package \href{https://CRAN.R-project.org/package=Matrix}{\pkg{Matrix}}.}
 }
 \value{
 \code{generer_contr_treatment_perso} renvoie
@@ -25,7 +37,8 @@ une fonction de contraste à substituer à \code{contr.treatment}.
 \code{ct_perso} est un exemple d'une telle fonction de contraste.
 }
 \description{
-Contrastes de traitement plus jolis
+Contrastes de traitement plus jolis. Voir \code{\link[stats:contrast]{stats::contr.treatment()}} pour plus
+d'informations.
 }
 \section{Functions}{
 \itemize{

man/sas_to_fst.Rd

@@ -20,7 +20,5 @@ Les chargements de ces fichiers sont plus rapides, et il est possible de ne sél
 que certaines colonnes et certaines lignes.
 }
 \examples{
-\dontrun{
-sas_to_fst("~/Documents/tables_sas", "~/Documents/tables_fst")
-}
+\dontrun{sas_to_fst("~/Documents/tables_sas", "~/Documents/tables_fst")}
 }

man/weighted_ntile.Rd

@@ -4,7 +4,7 @@
 \alias{weighted_ntile}
 \title{Discrétiser une variable continue selon des quantiles pondérés}
 \usage{
-weighted_ntile(x, w, n, french = FALSE)
+weighted_ntile(x, w, n, french = FALSE, ...)
 }
 \arguments{
 \item{x}{Vecteur de valeurs à discrétiser}

raccourcis.Rproj

@@ -18,4 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
-PackageRoxygenize: rd,collate,namespace
+PackageRoxygenize: rd,collate,namespace,vignette