From 2db710e01235cb3657cdc5a7269fe493529a6b5c Mon Sep 17 00:00:00 2001 From: Pierre-Yves Berrard Date: Fri, 27 Oct 2023 11:08:07 +0200 Subject: [PATCH] =?UTF-8?q?am=C3=A9liore=20documentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- R/validation_sirene.R | 16 ++++++++-------- README.Rmd | 14 ++++++++++++++ README.md | 15 +++++++++++++++ man/validation_sirene.Rd | 21 ++++++++++----------- 4 files changed, 47 insertions(+), 19 deletions(-) diff --git a/R/validation_sirene.R b/R/validation_sirene.R index 48dec60..d206b2a 100644 --- a/R/validation_sirene.R +++ b/R/validation_sirene.R @@ -27,17 +27,17 @@ somme_luhn <- function(id_int) { #' #' Vérifie la validité d'un vecteur de SIRET ou de SIREN. #' -#' Pour les SIREN et SIRET, la vérification est faite sur la base de -#' la [formule de Luhn](https://fr.wikipedia.org/wiki/Formule_de_Luhn). +#' La vérification se base sur la +#' [formule de Luhn](https://fr.wikipedia.org/wiki/Formule_de_Luhn). #' -#' Un SIREN est valide si sa somme de Luhn est un multipe de 10. +#' - un SIREN est valide si sa somme de Luhn est un multipe de 10 ; #' -#' Un SIRET est valide si sa somme de Luhn est un multipe de 10 et si la somme -#' de Luhn de son SIREN (9 premiers chiffres) est un multiple de 10. +#' - un SIRET est valide si sa somme de Luhn est un multipe de 10 et si la somme +#' de Luhn de son SIREN (9 premiers chiffres) est un multiple de 10 ; #' -#' Les SIRET de *La Poste* (SIREN 356000000) ne respectant pas cette règle font -#' l'objet d'un traitement différencié. Il seront considérés comme valides si -#' la somme des chiffres les composant est un multiple de 5. +#' - un SIRET de _La Poste_ (SIREN 356000000) ne respectant pas la règle +#' ci-dessus fait l'objet d'un traitement différencié : il est valide si la +#' somme des chiffres le composant est un multiple de 5. #' #' Les fonctions `validation_siren` et `validation_siret` permettent d'appeler #' `validation_sirene` sans avoir à préciser le type de numéro. diff --git a/README.Rmd b/README.Rmd index f0e2b6f..d6bdfcc 100644 --- a/README.Rmd +++ b/README.Rmd @@ -51,3 +51,17 @@ La fonction `validation_siret` vérifie si les éléments d'un vecteur sont des ```{r validation_siret} validation_siret(c("20003452800014", "20003452800041", NA)) ``` + +**Méthode** + +La vérification se base sur la +[formule de Luhn](https://fr.wikipedia.org/wiki/Formule_de_Luhn). + +- un SIREN est valide si sa somme de Luhn est un multipe de 10 ; + +- un SIRET est valide si sa somme de Luhn est un multipe de 10 et si la somme de + Luhn de son SIREN (9 premiers chiffres) est un multiple de 10 ; + +- un SIRET de _La Poste_ (SIREN 356000000) ne respectant pas la règle ci-dessus + fait l'objet d'un traitement différencié : il est valide si la somme des + chiffres le composant est un multiple de 5. diff --git a/README.md b/README.md index 421f6a2..573fa10 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,18 @@ caractères) : validation_siret(c("20003452800014", "20003452800041", NA)) #> [1] TRUE FALSE NA ``` + +**Méthode** + +La vérification se base sur la [formule de +Luhn](https://fr.wikipedia.org/wiki/Formule_de_Luhn). + +- un SIREN est valide si sa somme de Luhn est un multipe de 10 ; + +- un SIRET est valide si sa somme de Luhn est un multipe de 10 et si + la somme de Luhn de son SIREN (9 premiers chiffres) est un multiple + de 10 ; + +- un SIRET de *La Poste* (SIREN 356000000) ne respectant pas la règle + ci-dessus fait l’objet d’un traitement différencié : il est valide + si la somme des chiffres le composant est un multiple de 5. diff --git a/man/validation_sirene.Rd b/man/validation_sirene.Rd index 3ee9284..d761aa9 100644 --- a/man/validation_sirene.Rd +++ b/man/validation_sirene.Rd @@ -28,17 +28,16 @@ produira une valeur manquante en retour. Vérifie la validité d'un vecteur de SIRET ou de SIREN. } \details{ -Pour les SIREN et SIRET, la vérification est faite sur la base de -la \href{https://fr.wikipedia.org/wiki/Formule_de_Luhn}{formule de Luhn}. - -Un SIREN est valide si sa somme de Luhn est un multipe de 10. - -Un SIRET est valide si sa somme de Luhn est un multipe de 10 et si la somme -de Luhn de son SIREN (9 premiers chiffres) est un multiple de 10. - -Les SIRET de \emph{La Poste} (SIREN 356000000) ne respectant pas cette règle font -l'objet d'un traitement différencié. Il seront considérés comme valides si -la somme des chiffres les composant est un multiple de 5. +La vérification se base sur la +\href{https://fr.wikipedia.org/wiki/Formule_de_Luhn}{formule de Luhn}. +\itemize{ +\item un SIREN est valide si sa somme de Luhn est un multipe de 10 ; +\item un SIRET est valide si sa somme de Luhn est un multipe de 10 et si la somme +de Luhn de son SIREN (9 premiers chiffres) est un multiple de 10 ; +\item un SIRET de \emph{La Poste} (SIREN 356000000) ne respectant pas la règle +ci-dessus fait l'objet d'un traitement différencié : il est valide si la +somme des chiffres le composant est un multiple de 5. +} Les fonctions \code{validation_siren} et \code{validation_siret} permettent d'appeler \code{validation_sirene} sans avoir à préciser le type de numéro.