table <- charger("fichier.xls") : plus rien dans GlobalEnv

Correction de l'aide (lignes>100char) et ajouts

DESCRIPTION

@@ -8,7 +8,9 @@ Maintainer: Maxime Wack <maximewack@free.fr>
 Depends:
     xlsx
 Description: This package aims at the easy production of descriptive and
-    bivariate statistics tables in HTML. It is intended to be usable by
-    absolute R beginners. Ce paquet permet la production facile de tableaux
-    HTML descriptifs et comparatifs, meme pour les debutants sous R.
+    bivariate statistics tables in HTML. It can load files in csv, xls/xlsx
+    formats, and read labels and formats from SAS or plain text files. It is
+    intended to be usable by absolute R beginners. Ce paquet permet la
+    production facile de tableaux HTML descriptifs et comparatifs, meme pour
+    les debutants sous R.
 License: GPL-3

R/charger.R

@@ -2,22 +2,20 @@
 #' 
 #' Charge un fichier texte ou excel contenant les donnees ainsi que les formats et labels
 #' 
-#' La fonction charge les donnees contenues dans le fichier de donnees et cree une table de valeurs.
+#' La fonction charge les donnees contenues dans le fichier de donnees et renvoie une table de valeurs.
 #' Si des labels/formats sont definis ils seront appliques (fichiers labels.sas, formats.sas et attribformats.sas)
 #' 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).
+#' Le fichier de donnees est charge depuis ../../data/, les formats depuis le repertoire courant.
 #' @encoding UTF-8
 #' @param fichier Fichier de donnees a charger
-#' @param nom Nom de la data frame dans laquelle stocker les donnees chargees
 #' @param feuille Feuille a utiliser si fichier excel et en cas de feuilles mutiples (et qu'on veut acceder a une feuille au-dela de la premiere)
+#' @return La data frame avec les labels et formats
 #' @examples
-#' \dontrun{charger("donnees.xls", nom="Ma_table")}
+#' \dontrun{Ma_table <- charger("donnees.xls", feuille=2)}
 #' @export
-charger <- function(fichier,nom=NULL,feuille=1)
+charger <- function(fichier,feuille=1)
 {
-  if (is.null(nom))
-    nom=strsplit(fichier,"\\.")[[1]][1]
-  
   # Verification de la presence du fichier
   fichier<-paste("../../data/",fichier,sep="")
   if (!file.exists(fichier))
@@ -109,5 +107,5 @@ charger <- function(fichier,nom=NULL,feuille=1)
   }
   
   # Enregistrement de la table dans l'environnement
-  assign(nom,x,pos=1)
+  x
 }

R/desc_global.R

@@ -4,6 +4,7 @@
 #' 
 #' Permet de produire un tableau descriptif des variables contenues dans la table.
 #' Si les labels et formats sont definis et charges ils seront utilises pour peupler le tableau.
+#' Le fichier de sortie est place dans ../HTML Output
 #' @encoding UTF-8
 #' @param table Table a utiliser
 #' @param html Nom du fichier html, par defaut "desc_global.html"
@@ -16,10 +17,10 @@
 #' @param nbdec Nombre de decimales apres la virgule, par defaut 1
 #' @examples
 #' \dontrun{
-#' charger("donnees.xls", "Ma_table")
+#' Ma_table <- charger("donnees.xls")
 #' 
 #' desc_global(Ma_table) # descriptif par defaut
-#' desc_global(Ma_table, html="descriptif", titre="Tableau 1", variables=c("varquali1","varquali2"), stats=c("N","%"), note="Note de bas de page")
+#' desc_global(Ma_table, variables=c("var1","var2"), stats=c("N","%"), note="Note de bas de page")
 #' }
 #' @export
 desc_global <- function(table, html="desc_global", titre=NULL, variables=NULL, variables_neg=NULL, stats=c("N","%/moy","ic95"), miss=TRUE, note=NULL, nbdec=1)
@@ -171,17 +172,19 @@ desc_global <- function(table, html="desc_global", titre=NULL, variables=NULL, v
 #' Permet de produire un tableau descriptif des variables contenues dans la table.
 #' Si les labels et formats sont definis et charges ils seront utilises pour peupler le tableau.
 #' La fonction renvoie un vecteur de noms de variables considerees comme parametriques apres un test de normalite de Shapiro-Wilk.
+#' Le fichier est cree dans le repertoire temporaire. Il est possible de le sauvegarder avec ses graphiques a partir du navigateur.
 #' @encoding UTF-8
 #' @param table Table a utiliser
 #' @param variables Vecteur de noms de variables a decrire, par defaut toutes les variables contenues dans la table
 #' @param variables_neg Vecteur de noms de variables a exclure de la description
+#' @return Un vecteur contenant les variables considerees comme parametriques
 #' @examples
 #' \dontrun{
-#' charger("donnees.xls", nom="Ma_table")
+#' Ma_table <- charger("donnees.xls")
 #' 
 #' diagnostic(Ma_table) # diagnostic par defaut
 #' parametriques <- diagnostic(Ma_table, variables_neg=c("num_id"))
-#' # parametriques contient un vecteur de noms de variables considerees comme parametriques
+#' # parametriques contient le vecteur de noms de variables parametriques
 #' }
 #' @export
 diagnostic <- function(table, variables=NULL, variables_neg=NULL)

R/desc_groupe.R

@@ -4,6 +4,7 @@
 #' 
 #' Permet de produire un tableau comparatif des variables contenues dans la table passee en parametre selon les modalites d'une d'entre elles.
 #' Si les labels et formats sont definis et charges ils seront utilises pour peupler le tableau.
+#' Le fichier de sortie est place dans ../HTML Output
 #' @encoding UTF-8
 #' @param table Table a utiliser
 #' @param groupe Nom de la variable qualitative a utiliser pour la comparaison
@@ -17,12 +18,12 @@
 #' @param pourcent Pourcentages pour les variables qualitatives, en colonnes ("col") ou en lignes ("row"), par defaut sur le total
 #' @examples
 #' \dontrun{
-#' charger("donnees.xls", nom="Ma_table")
+#' Ma_table <- charger("donnees.xls")
 #' 
 #' desc_groupe(Ma_table, "sexe")
 #' 
-#' parametriques <- diagnostic(Ma_table)
-#' desc_groupe(Ma_table, "sexe", param = parametriques, html="Tableau2b.html", titre="Comparatif selon le sexe", variables=c("varquali1","varquali2"), note="Note de bas de page", nbdec=2, pourcent="row")
+#' para <- diagnostic(Ma_table)
+#' desc_groupe(Ma_table, "sexe", param = para, titre="Comparatif selon le sexe", pourcent="row")
 #' }
 #' @export
 desc_groupe <- function(table, groupe, param = character(0), html=NULL, titre=NULL, variables=NULL, variables_neg=NULL, note=NULL, nbdec=1, pourcent="total")

SEEC_Nancy.Rproj

@@ -14,4 +14,5 @@ LaTeX: pdfLaTeX
 
 BuildType: Package
 PackageInstallArgs: --no-multiarch
+PackageCheckArgs: --as-cran
 PackageRoxygenize: rd,collate,namespace

man/charger.Rd

@@ -3,33 +3,34 @@
 \alias{charger}
 \title{Charger un fichier de donnees dans l'environnement}
 \usage{
-charger(fichier, nom = NULL, feuille = 1)
+charger(fichier, feuille = 1)
 }
 \arguments{
   \item{fichier}{Fichier de donnees a charger}
 
-  \item{nom}{Nom de la data frame dans laquelle stocker les
-  donnees chargees}
-
   \item{feuille}{Feuille a utiliser si fichier excel et en
   cas de feuilles mutiples (et qu'on veut acceder a une
   feuille au-dela de la premiere)}
 }
+\value{
+La data frame avec les labels et formats
+}
 \description{
 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 (fichiers labels.sas,
-formats.sas et attribformats.sas) Les variables pour
-lesquelles un format est defini seront considerees comme
-des variables qualitatives. La table de valeurs prend
+donnees et renvoie une table de valeurs. Si des
+labels/formats sont definis ils seront appliques (fichiers
+labels.sas, formats.sas et attribformats.sas) 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).
+feuille). Le fichier de donnees est charge depuis
+../../data/, les formats depuis le repertoire courant.
 }
 \examples{
-\dontrun{charger("donnees.xls", nom="Ma_table")}
+\dontrun{Ma_table <- charger("donnees.xls", feuille=2)}
 }
 

man/desc_global.Rd

@@ -41,14 +41,14 @@ Produit un tableau descriptif d'une table
 Permet de produire un tableau descriptif des variables
 contenues dans la table. Si les labels et formats sont
 definis et charges ils seront utilises pour peupler le
-tableau.
+tableau. Le fichier de sortie est place dans ../HTML Output
 }
 \examples{
 \dontrun{
-charger("donnees.xls", "Ma_table")
+Ma_table <- charger("donnees.xls")
 
 desc_global(Ma_table) # descriptif par defaut
-desc_global(Ma_table, html="descriptif", titre="Tableau 1", variables=c("varquali1","varquali2"), stats=c("N","\%"), note="Note de bas de page")
+desc_global(Ma_table, variables=c("var1","var2"), stats=c("N","\%"), note="Note de bas de page")
 }
 }
 

man/desc_groupe.Rd

@@ -46,16 +46,16 @@ Permet de produire un tableau comparatif des variables
 contenues dans la table passee en parametre selon les
 modalites d'une d'entre elles. Si les labels et formats
 sont definis et charges ils seront utilises pour peupler le
-tableau.
+tableau. Le fichier de sortie est place dans ../HTML Output
 }
 \examples{
 \dontrun{
-charger("donnees.xls", nom="Ma_table")
+Ma_table <- charger("donnees.xls")
 
 desc_groupe(Ma_table, "sexe")
 
-parametriques <- diagnostic(Ma_table)
-desc_groupe(Ma_table, "sexe", param = parametriques, html="Tableau2b.html", titre="Comparatif selon le sexe", variables=c("varquali1","varquali2"), note="Note de bas de page", nbdec=2, pourcent="row")
+para <- diagnostic(Ma_table)
+desc_groupe(Ma_table, "sexe", param = para, titre="Comparatif selon le sexe", pourcent="row")
 }
 }
 

man/diagnostic.Rd

@@ -14,6 +14,10 @@ diagnostic(table, variables = NULL, variables_neg = NULL)
   \item{variables_neg}{Vecteur de noms de variables a
   exclure de la description}
 }
+\value{
+Un vecteur contenant les variables considerees comme
+parametriques
+}
 \description{
 Produit un tableau descriptif de la table et des graphiques
 pour la verification des conditions d'utilisation des tests
@@ -25,15 +29,17 @@ contenues dans la table. Si les labels et formats sont
 definis et charges ils seront utilises pour peupler le
 tableau. La fonction renvoie un vecteur de noms de
 variables considerees comme parametriques apres un test de
-normalite de Shapiro-Wilk.
+normalite de Shapiro-Wilk. Le fichier est cree dans le
+repertoire temporaire. Il est possible de le sauvegarder
+avec ses graphiques a partir du navigateur.
 }
 \examples{
 \dontrun{
-charger("donnees.xls", nom="Ma_table")
+Ma_table <- charger("donnees.xls")
 
 diagnostic(Ma_table) # diagnostic par defaut
 parametriques <- diagnostic(Ma_table, variables_neg=c("num_id"))
-# parametriques contient un vecteur de noms de variables considerees comme parametriques
+# parametriques contient le vecteur de noms de variables parametriques
 }
 }