Clean des manuels

Variables internes à HTML dans le bon namespace Encore quelques accents perdus
10 years ago · bc1ae56ee6
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -12,3 +12,10 @@ Description: This package aims at the easy production of descriptive and
    absolute R beginners. Ce paquet permet la production facile de tableaux
    HTML descriptifs et comparatifs, meme pour les debutants sous R.
 License: GPL-3
 Collate:
    'charger.R'
    'desc_global.R'
    'desc_groupe.R'
    'erreur.R'
    'html.R'
    'label.R'
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -1,6 +1,3 @@
 S3method("label<-",data.frame)
 S3method("label<-",default)
 S3method(label,default)
 export("label<-")
 export(HTML)
 export(HTMLEnd)
--- a/R/desc_groupe.R
+++ b/R/desc_groupe.R
@@ -9,12 +9,12 @@
 #' @param html Nom du fichier html, par defaut "desc_groupe_nomdelavariable.html"
 #' @param titre Titre du tableau, par defaut "Comparaison selon nom_de_la_variable"
 #' @param table Table a utiliser, par defaut la derniere chargee
 #' @param groupe Variable à utiliser pour la comparaison.
 #' @param groupe Variable a utiliser pour la comparaison
 #' @param variables Vecteur de noms de variables a comparer, par defaut toutes les variables contenues dans la table moins celle servant de comparateur
 #' @param variables_neg Vecteur de noms de variables a exclure de la comparaison
 #' @param note Note de bas de page, par defaut vide
 #' @param nbdec Nombre de decimales apres la virgule, par defaut 1
 #' @param pourcent Pourcentages pour les variables qualitatives, en colonnes ("col") ou en lignes ("row"), par défaut sur le total
 #' @param pourcent Pourcentages pour les variables qualitatives, en colonnes ("col") ou en lignes ("row"), par defaut sur le total
 #' @export
 desc_groupe <- function(groupe=NULL, html=NULL, titre=NULL, table=NULL, variables=NULL, variables_neg=NULL, note=NULL, nbdec=1, pourcent=NULL)
 {
--- a/R/html.R
+++ b/R/html.R
@@ -1,3 +1,7 @@
 .HTML.file <- NULL
 .tabs <- 0
 .ligne <- F

 #' Initialiser un fichier HTML
 #' 
 #' Cree et remplit les headers pour un fichier hTML
@@ -11,12 +15,18 @@
 #' @export
 HTMLInit <- function(file=tempfile(pattern="report", fileext=".html"), title="", CSSfile="")
 {
  file.copy(from=file.path(path.package("cosmosR"),"inst","desc.css"), to=file.path(dirname(file),"desc.css"),overwrite=T)
  file.copy(from=file.path(path.package("cosmosR"),"inst","diag.css"), to=file.path(dirname(file),"diag.css"),overwrite=T)
  file.copy(from=file.path(path.package("cosmosR"),"inst","cosmosR.js"), to=file.path(dirname(file),"cosmosR.js"),overwrite=T)
  assign(".HTML.file", file, pos=1)
  assign(".tabs", 0, pos=1)
  assign(".ligne",F,pos=1)
  file.copy(from=file.path(path.package("cosmosR"),"desc.css"), to=file.path(dirname(file),"desc.css"),overwrite=T)
  file.copy(from=file.path(path.package("cosmosR"),"diag.css"), to=file.path(dirname(file),"diag.css"),overwrite=T)
  file.copy(from=file.path(path.package("cosmosR"),"cosmosR.js"), to=file.path(dirname(file),"cosmosR.js"),overwrite=T)
  #assign(".HTML.file", file, pos=1)
  #assign(".tabs", 0, pos=1)
  #assign(".ligne",F,pos=1)
  unlockBinding(".HTML.file", env=asNamespace("cosmosR"))
  unlockBinding(".tabs", env=asNamespace("cosmosR"))
  unlockBinding(".ligne", env=asNamespace("cosmosR"))
  .HTML.file <<- file
  .tabs <<- 0
  .ligne <<- F
  
  HTML("<!DOCTYPE html>", append=F)
  HTML("<HTML>")
@@ -42,7 +52,10 @@ HTMLInit <- function(file=tempfile(pattern="report", fileext=".html"), title="",
 #' @export
 HTMLEnd <- function()
 {
  if (!exists(".HTML.file")) return
  #if (!exists(".HTML.file")) return
  if (is.null(.HTML.file)) return
  
  unlockBinding(".HTML.file", env=asNamespace("cosmosR"))
  
    dec()
    HTML("</BODY>")
@@ -50,7 +63,8 @@ HTMLEnd <- function()
  HTML("</HTML>")
  
  browseURL(.HTML.file)
  rm(.HTML.file,pos=1)
  #rm(.HTML.file,pos=1)
  .HTML.file <<- NULL
 }

 #' Ecrit dans le fichier HTML
@@ -66,7 +80,10 @@ HTMLEnd <- function()
 #' @export
 HTML <- function(x, ..., append=T,sep="\n")
 {
  if (!exists(".HTML.file")) return
  #if (!exists(".HTML.file")) return
  if (is.null(.HTML.file)) return
  
  unlockBinding(".ligne", env=asNamespace("cosmosR"))
  
  x <- paste0(x,...,collapse="")
  
@@ -76,9 +93,11 @@ HTML <- function(x, ..., append=T,sep="\n")
    tabs <- paste0(rep("\t", .tabs),collapse="")
  
  if (sep == "\n")
    assign(".ligne", F, pos=1)
    #assign(".ligne", F, pos=1)
    .ligne <<- F
  else
    assign(".ligne", T, pos=1)
    #assign(".ligne", T, pos=1)
    .ligne <<-T
  
  x <- paste0(tabs, x)
  
@@ -87,10 +106,14 @@ HTML <- function(x, ..., append=T,sep="\n")

 inc <- function()
 {
  assign(".tabs", .tabs+1)
  unlockBinding(".tabs", env=asNamespace("cosmosR"))
  #assign(".tabs", .tabs+1)
  .tabs <<- .tabs+1
 }

 dec <- function()
 {
  if (.tabs>0) assign(".tabs", .tabs-1)
  #if (.tabs>0) assign(".tabs", .tabs-1)
  unlockBinding(".tabs", env=asNamespace("cosmosR"))
  if (.tabs>0) .tabs <<- .tabs-1
 }
--- a/R/label.R
+++ b/R/label.R
@@ -12,8 +12,6 @@
 #' @return Renvoie une chaine de caracteres contenant l'etiquette de l'objet
 label <- function(objet) UseMethod("label")

 #' @rdname label
 #' @export
 label.default <- function(objet)
 {
  if (missing(objet))
@@ -28,8 +26,6 @@ label.default <- function(objet)
 #' @export
 "label<-" <- function(objet,value) UseMethod("label<-")

 #' @rdname label
 #' @export
 "label<-.default" <- function(objet,value)
 {
  attr(objet,"label")<-value[[1]]
@@ -37,8 +33,6 @@ label.default <- function(objet)
  objet
 }

 #' @rdname label
 #' @export
 "label<-.data.frame" <- function(objet,value)
 {
  if (length(value)==1 && is.null(names(value)))
--- a/man/HTML.Rd
+++ b/man/HTML.Rd
@@ -3,7 +3,7 @@
 \alias{HTML}
 \title{Ecrit dans le fichier HTML}
 \usage{
 HTML(x, ..., append = T, sep = "\\n")
  HTML(x, ..., append = T, sep = "\n")
 }
 \arguments{
  \item{x}{Contenu a ecrire}
@@ -17,10 +17,10 @@ HTML(x, ..., append = T, sep = "\\n")
  ecrire sur la meme ligne du fichier}
 }
 \description{
 Ecrit dans le fichier HTML cree par HTMLInit
  Ecrit dans le fichier HTML cree par HTMLInit
 }
 \details{
 Ecrit dans le fichier initialise par HTMLInit dont le nom
 est contenu dans .HTML.file
  Ecrit dans le fichier initialise par HTMLInit dont le nom
  est contenu dans .HTML.file
 }

--- a/man/HTMLEnd.Rd
+++ b/man/HTMLEnd.Rd
@@ -3,13 +3,13 @@
 \alias{HTMLEnd}
 \title{Termine et clos le fichier HTML}
 \usage{
 HTMLEnd()
  HTMLEnd()
 }
 \description{
 Ecrit le footer du fichier hTML
  Ecrit le footer du fichier hTML
 }
 \details{
 Ecrit le footer du fichier initialise par HTMLInit, ouvre
 le fichier dans le navigateur et supprime l'acces.
  Ecrit le footer du fichier initialise par HTMLInit, ouvre
  le fichier dans le navigateur et supprime l'acces.
 }

--- a/man/HTMLInit.Rd
+++ b/man/HTMLInit.Rd
@@ -3,8 +3,8 @@
 \alias{HTMLInit}
 \title{Initialiser un fichier HTML}
 \usage{
 HTMLInit(file = tempfile(pattern = "report", fileext = ".html"), title = "",
  CSSfile = "")
  HTMLInit(file = tempfile(pattern = "report", fileext = ".html"),
    title = "", CSSfile = "")
 }
 \arguments{
  \item{file}{Nom du fichier HTML a creer, par defaut un
@@ -15,11 +15,11 @@ HTMLInit(file = tempfile(pattern = "report", fileext = ".html"), title = "",
  \item{CSSfile}{Fichier CSS a utiliser}
 }
 \description{
 Cree et remplit les headers pour un fichier hTML
  Cree et remplit les headers pour un fichier hTML
 }
 \details{
 Si aucun nom de fichier n'est fourni, cree un fichier
 temporaire dans le repertoire temporaire Le nom du fichier
 actuel est stocke dans .HTML.file
  Si aucun nom de fichier n'est fourni, cree un fichier
  temporaire dans le repertoire temporaire Le nom du
  fichier actuel est stocke dans .HTML.file
 }

--- a/man/charger.Rd
+++ b/man/charger.Rd
@@ -3,7 +3,7 @@
 \alias{charger}
 \title{Charger un fichier de donnees dans l'environnement}
 \usage{
 charger(fichier, nom = NULL, feuille = 1)
  charger(fichier, nom = NULL, feuille = 1)
 }
 \arguments{
  \item{fichier}{Fichier de donnees a charger}
@@ -16,16 +16,17 @@ charger(fichier, nom = NULL, feuille = 1)
  feuille au-dela de la premiere)}
 }
 \description{
 Charge un fichier texte ou excel contenant les donnees
 ainsi que les formats et labels
  Charge un fichier texte ou excel contenant les donnees
  ainsi que les formats et labels
 }
 \details{
 La fonction charge les donnees contenues dans le fichier de
 donnees et cree une table de valeurs. Si des labels/formats
 sont definis ils seront appliques. Les variables pour
 lesquelles un format est defini seront considerees comme
 des variables qualitatives. La table de valeurs prend
 automatiquement le nom du fichier (suffixe par le numero de
 feuille) et est attachee a l'environnement courant.
  La fonction charge les donnees contenues dans le fichier
  de donnees et cree une table de valeurs. Si des
  labels/formats sont definis ils seront appliques. Les
  variables pour lesquelles un format est defini seront
  considerees comme des variables qualitatives. La table de
  valeurs prend automatiquement le nom du fichier (suffixe
  par le numero de feuille) et est attachee a
  l'environnement courant.
 }

--- a/man/desc_global.Rd
+++ b/man/desc_global.Rd
@@ -3,9 +3,10 @@
 \alias{desc_global}
 \title{Descriptif global de la table courante}
 \usage{
 desc_global(html = "desc_global", titre = NULL, table = NULL,
  variables = NULL, variables_neg = NULL, stats = c("N", "\%/moy",
  "ic95"), miss = TRUE, note = NULL, nbdec = 1)
  desc_global(html = "desc_global", titre = NULL,
    table = NULL, variables = NULL, variables_neg = NULL,
    stats = c("N", "\%/moy", "ic95"), miss = TRUE,
    note = NULL, nbdec = 1)
 }
 \arguments{
  \item{html}{Nom du fichier html, par defaut
@@ -36,14 +37,14 @@ desc_global(html = "desc_global", titre = NULL, table = NULL,
  defaut 1}
 }
 \description{
 Produit un tableau descriptif de la table courante
  Produit un tableau descriptif de la table courante
 }
 \details{
 Permet de produire un tableau descriptif des variables
 contenues dans la table courante. Si les labels et formats
 sont definis et charges ils seront utilises pour peupler le
 tableau. Tous les parametres ont une valeur par defaut, il
 est donc possible de simplement lancer desc() pour obtenir
 un tableau descriptif par defaut.
  Permet de produire un tableau descriptif des variables
  contenues dans la table courante. Si les labels et
  formats sont definis et charges ils seront utilises pour
  peupler le tableau. Tous les parametres ont une valeur
  par defaut, il est donc possible de simplement lancer
  desc() pour obtenir un tableau descriptif par defaut.
 }

--- a/man/desc_groupe.Rd
+++ b/man/desc_groupe.Rd
@@ -3,9 +3,9 @@
 \alias{desc_groupe}
 \title{Comparatif par groupe de la table courante}
 \usage{
 desc_groupe(groupe = NULL, html = NULL, titre = NULL, table = NULL,
  variables = NULL, variables_neg = NULL, note = NULL, nbdec = 1,
  pourcent = NULL)
  desc_groupe(groupe = NULL, html = NULL, titre = NULL,
    table = NULL, variables = NULL, variables_neg = NULL,
    note = NULL, nbdec = 1, pourcent = NULL)
 }
 \arguments{
  \item{html}{Nom du fichier html, par defaut
@@ -17,7 +17,7 @@ desc_groupe(groupe = NULL, html = NULL, titre = NULL, table = NULL,
  \item{table}{Table a utiliser, par defaut la derniere
  chargee}

  \item{groupe}{Variable à utiliser pour la comparaison.}
  \item{groupe}{Variable a utiliser pour la comparaison}

  \item{variables}{Vecteur de noms de variables a comparer,
  par defaut toutes les variables contenues dans la table
@@ -33,19 +33,19 @@ desc_groupe(groupe = NULL, html = NULL, titre = NULL, table = NULL,

  \item{pourcent}{Pourcentages pour les variables
  qualitatives, en colonnes ("col") ou en lignes ("row"),
  par défaut sur le total}
  par defaut sur le total}
 }
 \description{
 Produit un tableau comparatif par groupe de la table
 courante
  Produit un tableau comparatif par groupe de la table
  courante
 }
 \details{
 Permet de produire un tableau comparatif des variables
 contenues dans la table courante selon les modalites d'une
 d'entre elles. Si les labels et formats sont definis et
 charges ils seront utilises pour peupler le tableau. Tous
 les parametres ont une valeur par defaut, il est donc
 possible de simplement lancer desc() pour obtenir un
 tableau descriptif par defaut.
  Permet de produire un tableau comparatif des variables
  contenues dans la table courante selon les modalites
  d'une d'entre elles. Si les labels et formats sont
  definis et charges ils seront utilises pour peupler le
  tableau. Tous les parametres ont une valeur par defaut,
  il est donc possible de simplement lancer desc() pour
  obtenir un tableau descriptif par defaut.
 }

--- a/man/diagnostic.Rd
+++ b/man/diagnostic.Rd
@@ -3,27 +3,27 @@
 \alias{diagnostic}
 \title{Diagnostics de la table courante}
 \usage{
 diagnostic(table = NULL)
  diagnostic(table = NULL)
 }
 \arguments{
  \item{table}{Table a utiliser, par defaut la derniere
  chargee}
 }
 \description{
 Produit un tableau descriptif de la table courante et des
 graphiques pour la verification des conditions
 d'utilisation des tests satistiques
  Produit un tableau descriptif de la table courante et des
  graphiques pour la verification des conditions
  d'utilisation des tests satistiques
 }
 \details{
 Permet de produire un tableau descriptif des variables
 contenues dans la table courante. Si les labels et formats
 sont definis et charges ils seront utilises pour peupler le
 tableau. La fonction attribue un paramètre "param" à
 chaque variable à partir de tests de normalité, ce
 paramètre est modifiable ensuite, il conditionne
 l'utilisation des tests statistiques dans la fonction
 comparer(). Tous les parametres ont une valeur par defaut,
 il est donc possible de simplement lancer diag() pour
 obtenir le diagnostic par defaut.
  Permet de produire un tableau descriptif des variables
  contenues dans la table courante. Si les labels et
  formats sont definis et charges ils seront utilises pour
  peupler le tableau. La fonction attribue un paramètre
  "param" à chaque variable à partir de tests de normalité,
  ce paramètre est modifiable ensuite, il conditionne
  l'utilisation des tests statistiques dans la fonction
  comparer(). Tous les parametres ont une valeur par
  defaut, il est donc possible de simplement lancer diag()
  pour obtenir le diagnostic par defaut.
 }

--- a/man/label.Rd
+++ b/man/label.Rd
@@ -1,21 +1,12 @@
 \encoding{UTF-8}
 \name{label}
 \alias{label}
 \alias{label.default}
 \alias{label<-}
 \alias{label<-.data.frame}
 \alias{label<-.default}
 \title{Etiquetter un objet}
 \usage{
 label(objet)
  label(objet)

 \method{label}{default}(objet)

 label(objet) <- value

 \method{label}{default}(objet) <- value

 \method{label}{data.frame}(objet) <- value
  label(objet, value) <- value
 }
 \arguments{
  \item{objet}{L'objet a nommer}
@@ -23,15 +14,15 @@ label(objet) <- value
  \item{value}{Le texte de l'etiquette}
 }
 \value{
 Renvoie une chaine de caracteres contenant l'etiquette de
 l'objet
  Renvoie une chaine de caracteres contenant l'etiquette de
  l'objet
 }
 \description{
 Attribuer ou recuperer l'etiquette d'un objet
  Attribuer ou recuperer l'etiquette d'un objet
 }
 \details{
 Methode par defaut pour acceder et modifier l'etiquette
 d'un objet ou d'un element d'un objet. Il est possible de
 supprimer l'etiquette en passant NULL a la fonction.
  Methode par defaut pour acceder et modifier l'etiquette
  d'un objet ou d'un element d'un objet. Il est possible de
  supprimer l'etiquette en passant NULL a la fonction.
 }