selectitems renommee en bmdfilter

lbbe-software · Nov 28, 2023 · a8818f3 · a8818f3
1 parent 085517b
commit a8818f3
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 29 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -63,7 +63,7 @@ export(trendplot)
 export(sensitivityplot)
 export(bmdplot)
 export(selectgroups)
-export(selectitems)
+export(bmdfilter)
 export(PCAdataplot)
 export(formatdata4DRomics)
 
diff --git a/NEWS.md b/NEWS.md
@@ -9,7 +9,7 @@ NEW FEATURES
 - Add the possibility (new argument addBMD of curvesplot()) to add points at BMD-BMR values on curvesplots
 and put it by default at TRUE.
 - Add the Peer Community Journal citation.
-- Add of the function selectitems() proposing filters to retain
+- Add of the function bmdfilter() proposing filters to retain
 only the items associated to the best estimated BMD values in DRomics workflow output.
 - Add of arguments line.size, line.alpha and point.alpha in sensitivityplot() and in bmdplot()
 

diff --git a/R/selectitems.R → R/bmdfilter.R b/R/selectitems.R → R/bmdfilter.R
@@ -1,11 +1,11 @@
-selectitems <- function(res,
+bmdfilter <- function(res,
                         BMDfilter = c("definedCI", "finiteCI", "definedBMD", "none"),
                         BMDtype = c("zSD", "xfold")
                         )
 {
   if (missing(res) | !is.data.frame(res))
-    stop("The first argument of selectitems must be a dataframe 
-    (see ?selectitems for details).")
+    stop("The first argument of bmdfilter must be a dataframe 
+    (see ?bmdfilter for details).")
 
   BMDfilter <- match.arg(BMDfilter, c("definedCI", "finiteCI", "definedBMD", "none"))
   BMDtype <- match.arg(BMDtype, c("zSD", "xfold"))
@@ -15,13 +15,13 @@ selectitems <- function(res,
   if ((BMDtype == "zSD") & (BMDfilter != "none"))
   {  
     if (any(!is.element(c("BMD.zSD"), cnames)))
-      stop("The first argument of selectitems must be a dataframe
+      stop("The first argument of bmdfilter must be a dataframe
       containing a column named BMD.zSD.")
     BMD <- res$BMD.zSD
     if ((BMDfilter ==  "definedCI") | (BMDfilter ==  "finiteCI"))
     {
       if (any(!is.element(c("BMD.zSD.upper", "BMD.zSD.lower"), cnames)) )
-      stop("To apply a filter on BMD.zSD confidence intervals, the first argument of selectitems 
+      stop("To apply a filter on BMD.zSD confidence intervals, the first argument of bmdfilter 
       must be a dataframe containing columns named BMD.zSD, BMD.zSD.lower, BMD.zSD.upper.")
       BMDupper <- res$BMD.zSD.upper
       BMDlower <- res$BMD.zSD.lower
@@ -30,13 +30,13 @@ selectitems <- function(res,
   if ((BMDtype == "xfold") & (BMDfilter != "none"))
   {
     if (any(!is.element(c("BMD.xfold"), cnames)))
-      stop("The first argument of selectitems must be a dataframe
+      stop("The first argument of bmdfilter must be a dataframe
       containing a column named BMD.xfold.")
     BMD <- res$BMD.xfold
     if ((BMDfilter ==  "definedCI") | (BMDfilter ==  "finiteCI"))
     {
       if (any(!is.element(c("BMD.xfold.upper","BMD.xfold.lower"), cnames)))
-        stop("To apply a filter on BMD.xfold confidence intervals, the first argument of selectitems 
+        stop("To apply a filter on BMD.xfold confidence intervals, the first argument of bmdfilter 
       must be a dataframe containing columns named BMD.xfold, BMD.xfold.lower, BMD.xfold.upper.")
       BMDupper <- res$BMD.xfold.upper
       BMDlower <- res$BMD.xfold.lower

diff --git a/man/selectitems.Rd → man/bmdfilter.Rd b/man/selectitems.Rd → man/bmdfilter.Rd
@@ -1,14 +1,14 @@
-\name{selectitems}
-\alias{selectitems}
-\title{Selection of items to be retained in DRomics workflow output}
+\name{bmdfilter}
+\alias{bmdfilter}
+\title{Filtering of items in DRomics workflow output}
 
 \description{
-Selection of items (e.g. transcripts, metabolites, ...)
-to be retained in DRomics workflow output for further biological annotation and interpretation.
+Filtering of items (e.g. transcripts, metabolites, ...)
+to be removed from DRomics workflow output before further biological annotation and interpretation.
 }
 
 \usage{
-selectitems(res, 
+bmdfilter(res, 
               BMDfilter = c("definedCI", "finiteCI", "definedBMD", "none"),
               BMDtype = c("zSD", "xfold"))
 }
@@ -106,39 +106,39 @@ set.seed(1234) # to get reproducible results with a so small number of iteration
 ### (1.a) Examples on BMD.xfold (with some undefined BMD.xfold values)
 
 # Plot of BMDs with no filtering
-subres <- selectitems(b$res, BMDfilter = "none")
+subres <- bmdfilter(b$res, BMDfilter = "none")
 bmdplot(subres, BMDtype = "xfold", point.size = 3, add.CI = TRUE)
 
 # Plot of items with defined BMD point estimate
-subres <- selectitems(b$res, BMDtype = "xfold", BMDfilter = "definedBMD")
+subres <- bmdfilter(b$res, BMDtype = "xfold", BMDfilter = "definedBMD")
 bmdplot(subres, BMDtype = "xfold", point.size = 3, add.CI = TRUE)
 
 # Plot of items with defined BMD point estimate and CI bounds
-subres <- selectitems(b$res, BMDtype = "xfold", BMDfilter = "definedCI")
+subres <- bmdfilter(b$res, BMDtype = "xfold", BMDfilter = "definedCI")
 bmdplot(subres, BMDtype = "xfold", point.size = 3, add.CI = TRUE)
 
 # Plot of items with finite BMD point estimate and CI bounds
-subres <- selectitems(b$res, BMDtype = "xfold", BMDfilter = "finiteCI") 
+subres <- bmdfilter(b$res, BMDtype = "xfold", BMDfilter = "finiteCI") 
 bmdplot(subres, BMDtype = "xfold", point.size = 3, add.CI = TRUE)
 
 \donttest{
 
 ### (1.b) Examples on BMD.zSD (with no undefined BMD.zSD values)
 
 # Plot of BMDs with no filtering
-subres <- selectitems(b$res, BMDfilter = "none")
+subres <- bmdfilter(b$res, BMDfilter = "none")
 bmdplot(subres, BMDtype = "zSD", point.size = 3, add.CI = TRUE)
 
 # Plot items with defined BMD point estimate (the same on this ex.)
-subres <- selectitems(b$res, BMDtype = "zSD", BMDfilter = "definedBMD")
+subres <- bmdfilter(b$res, BMDtype = "zSD", BMDfilter = "definedBMD")
 bmdplot(subres, BMDtype = "zSD", point.size = 3, add.CI = TRUE)
 
 # Plot of items with defined BMD point estimate and CI bounds
-subres <- selectitems(b$res, BMDtype = "zSD", BMDfilter = "definedCI")
+subres <- bmdfilter(b$res, BMDtype = "zSD", BMDfilter = "definedCI")
 bmdplot(subres, BMDtype = "zSD", point.size = 3, add.CI = TRUE)
 
 # Plot of items with finite BMD point estimate and CI bounds
-subres <- selectitems(b$res, BMDtype = "zSD", BMDfilter = "finiteCI") 
+subres <- bmdfilter(b$res, BMDtype = "zSD", BMDfilter = "finiteCI") 
 bmdplot(subres, BMDtype = "zSD", point.size = 3, add.CI = TRUE)
 }
 

diff --git a/man/selectgroups.Rd b/man/selectgroups.Rd
@@ -75,7 +75,7 @@ This function eliminates rows with NA values for the chosen BMD
 }
 
 \seealso{
-    See \code{\link{selectitems}}, \code{\link{bmdplot}}, \code{\link{bmdplotwithgradient}}, 
+    See \code{\link{bmdfilter}}, \code{\link{bmdplot}}, \code{\link{bmdplotwithgradient}}, 
     \code{\link{trendplot}} and \code{\link{sensitivityplot}}.
 }
 

diff --git a/share/todolist.md b/share/todolist.md
@@ -29,7 +29,7 @@ quand le theme n'est pas défini dans la fonction.
 FAIT dans vignette à faire dans shiny (A)
 A FAIRE dans DRomics-shiny pour les fonctions plot.continuousanchoringdata(), PCAdataplot() et plot.bmdcalc()
 A FAIRE dans DRomicsInterpreter-shiny pour les fonctions sensitivityplot(), trendplot(), bmdplot() et curvesplot()
-1. [X] Ajouter une fonction selectitems permettant de filtrer les sorties de DRomics notamment sur la base des résultats du bootstrap (par défaut on ne garde 
+1. [X] Ajouter une fonction bmdfilter permettant de filtrer les sorties de DRomics notamment sur la base des résultats du bootstrap (par défaut on ne garde 
 que les items avec BMD et IC de la BMD définis, pour la BMD-zSD par défaut) - penser à faire de la prog défensive si les utilisateurs ne mettent pas le bootstrap, filtre possible sur autre chose.... (ML)
 1. [ ] Envisager la sortie de  figures en plotly, dans la vignette et dans l'appli shiny.
 FAIT dans vignette aussi juste sur un curvesplot(), avec un if require(plotly) et plotly ajouté en suggest (ML)
@@ -42,12 +42,12 @@ Dans intro ajouter juste avant la phrase sur les données apicales
 "Proteomics data can also be handled, as metabolomics data when expressed in intensity (continuous variable)
 or as RNAseq data when expressed in spectral counts".
 Dans step 1, A discuter encore : faut-il le rappeler vers les boutons correspondants ou plus tard quand on aura plus d'expe ?
-1. [ ] Dans DRomics-shiny ajouter une mention à selectitems dans R code to go further (A)
+1. [ ] Dans DRomics-shiny ajouter une mention à bmdfilter dans R code to go further (A)
 Après le dernier commentaire sur les fonctions d'exploration 
 "# Before the biological interpretation of results, one could retain
 only the items associated to the best estimated BMD values, 
-using the function selectitems (see ?selectitems for a description of the proposed options)
-subres <- selectitems(b$res, BMDtype = "zSD", BMDfilter = "definedCI")"
+using the function bmdfilter (see ?bmdfilter for a description of the proposed options)
+subres <- bmdfilter(b$res, BMDtype = "zSD", BMDfilter = "definedCI")"
 1. [ ] Regarder pourquoi la dernière figure de la partie 3.1.2.2 de la vignette (code fourni)
 ne permet plus d'afficher les labels des groupes
 uniquement sur les points et pas sur l'axe des y (A)
@@ -60,7 +60,7 @@ comment ils collent en symétrie resp. aux belle et inc (ML après discussion av
 1. [ ] ajouter dans le curvesplot un argument pour changer que le type de point soit
 guider par le pathway (intéressant en interactif - à discuter !) (ML)
 1. [ ] revoir l'argument remove.infinite de plot.bmdboot, sa valeur par défaut et son fonctionnement, pour que ce soit harmonisé avec les valeurs par défaut 
-de selectitems (pb avec xfold, vérifier que ça marche bien) ou enlever cette fonctionnalité et considérer que c'est fait avec selectitems et quand ce n'est pas fait gérer graphiquement les infinis
+de bmdfilter (pb avec xfold, vérifier que ça marche bien) ou enlever cette fonctionnalité et considérer que c'est fait avec bmdfilter et quand ce n'est pas fait gérer graphiquement les infinis
 1. [ ] Ajouter des options "boxplot" dans BMDsummary de sensitivityplot(A)
 1. [ ] Add Danio rerio data in the package as another example for the functions for Dromics results interpretation (with or without enrichment and/or with outlier - elimination as in the paper (IRSN) ou un autre ex. (ML)
 1. [ ] Ajouter un ou deux sous-niveaux dans la vignette à laquelle on accède depuis GitHub (A) IMPOSSIBLE à cause des configurations de pkgdown ! Restructurer la vignette pour que la navigation soit plus simple - en parallèle de la rédaction de la FAQ dans laquelle basculeront des morceaux de la vignette en faisant attention à maintenir les liens de l'article PCI