Arguments par défaut

Introduction à l’écriture de fonctions en R

Richie Cotton

Data Evangelist at DataCamp

Problèmes avec toss_coin()

toss_coin <- function(n_flips, p_head) {
  coin_sides <- c("head", "tail")
  weights <- c(p_head, 1 - p_head)
  sample(coin_sides, n_flips, replace = TRUE, prob = weights)
}

Définir la valeur par défaut dans la signature

toss_coin <- function(n_flips, p_head = 0.5) {
  coin_sides <- c("head", "tail")
  weights <- c(p_head, 1 - p_head)
  sample(coin_sides, n_flips, replace = TRUE, prob = weights)
}
Introduction à l’écriture de fonctions en R

Un modèle avec valeurs par défaut

my_fun <- function(data_arg1, data_arg2, detail_arg1 = default1) {
  # Do something
}
Introduction à l’écriture de fonctions en R

Autres types de valeur par défaut

args(median)

function (x, na.rm = FALSE, ...)

library(jsonlite)
args(fromJSON)

function (txt, simplifyVector = TRUE, simplifyDataFrame = simplifyVector, 
    simplifyMatrix = simplifyVector, flatten = FALSE, ...)
Introduction à l’écriture de fonctions en R

Valeurs NULL par défaut

Par convention, cela signifie :

La fonction traite cet argument de façon spéciale. Veuillez lire la documentation.

args(set.seed)

function (seed, kind = NULL, normal.kind = NULL)
Introduction à l’écriture de fonctions en R

Valeurs catégorielles par défaut

  1. Passer un vecteur de chaînes dans la signature.
  2. Appeler match.arg() dans le corps.
args(prop.test)

function (x, n, p = NULL, alternative = c("two.sided", "less", "greater"), 
  conf.level = 0.95, correct = TRUE)

Dans le corps

alternative <- match.arg(alternative)
Introduction à l’écriture de fonctions en R

Découper un vecteur par quantiles

cut_by_quantile <- function(x, n, na.rm, labels, interval_type) {
  probs <- seq(0, 1, length.out = n + 1)
  quantiles <- quantile(x, probs, na.rm = na.rm, names = FALSE)
  right <- switch(interval_type, "(lo, hi]" = TRUE, "[lo, hi)" = FALSE)
  cut(x, quantiles, labels = labels, right = right, include.lowest = TRUE)
}
  • x : vecteur numérique à découper
  • n : nombre de catégories pour découper x
  • na.rm : faut-il supprimer les valeurs manquantes ?
  • labels : étiquettes (caractères) des catégories
  • interval_type : intervalles ouverts à gauche ou à droite ?
Introduction à l’écriture de fonctions en R

Poids du cœur de chats

Un strip plot des poids du cœur de chats. L'intervalle va de 3 à 20 grammes.

quantile(cats$Hwt)

    0%    25%    50%    75%   100% 
 6.300  8.950 10.100 12.125 20.500
1 data(cats, package = "MASS")
Introduction à l’écriture de fonctions en R

Découper par quantiles

Le strip plot de la diapositive précédente est coloré : points rouges à gauche, puis verts, turquoise, et violets à droite.

cut(x, quantile(x))
Introduction à l’écriture de fonctions en R

Passons à la pratique !

Introduction à l’écriture de fonctions en R

Preparing Video For Download...