Browse code

Updated package metadata

Jaehyun Joo authored on 02/04/2023 21:27:04
Showing 5 changed files

... ...
@@ -1,6 +1,6 @@
1 1
 Package: qmtools
2 2
 Title: Quantitative Metabolomics Data Processing Tools
3
-Version: 1.3.0
3
+Version: 1.3.1
4 4
 Authors@R: c(
5 5
     person(given = "Jaehyun",
6 6
            family = "Joo",
... ...
@@ -16,8 +16,10 @@ Description: The qmtools (quantitative metabolomics tools) package provides
16 16
              standard SummarizedExperiment class. This includes functions for
17 17
              imputation, normalization, feature filtering, feature clustering,
18 18
              dimension-reduction, and visualization to help users prepare data
19
-             for statistical analysis. Several functions in this package could
20
-             also be used in other types of omics data.
19
+             for statistical analysis. This package also offers a convenient way
20
+             to compute empirical Bayes statistics for which metabolic features
21
+             are different between two sets of study samples. Several functions
22
+             in this package could also be used in other types of omics data.
21 23
 License: GPL-3
22 24
 Encoding: UTF-8
23 25
 Roxygen: list(markdown = TRUE)
... ...
@@ -68,6 +68,7 @@ importFrom(limma,normalizeCyclicLoess)
68 68
 importFrom(limma,topTable)
69 69
 importFrom(methods,is)
70 70
 importFrom(patchwork,plot_layout)
71
+importFrom(stats,as.formula)
71 72
 importFrom(stats,cor)
72 73
 importFrom(stats,cutree)
73 74
 importFrom(stats,dist)
... ...
@@ -83,6 +84,8 @@ importFrom(stats,reshape)
83 84
 importFrom(stats,residuals)
84 85
 importFrom(stats,sd)
85 86
 importMethodsFrom(SummarizedExperiment,"assay<-")
87
+importMethodsFrom(SummarizedExperiment,"colData<-")
86 88
 importMethodsFrom(SummarizedExperiment,"rowData<-")
87 89
 importMethodsFrom(SummarizedExperiment,assay)
90
+importMethodsFrom(SummarizedExperiment,colData)
88 91
 importMethodsFrom(SummarizedExperiment,rowData)
... ...
@@ -1,6 +1,6 @@
1 1
 ##' @importClassesFrom SummarizedExperiment SummarizedExperiment
2 2
 ##' @importMethodsFrom SummarizedExperiment assay assay<-
3
-##' @importMethodsFrom SummarizedExperiment rowData rowData<-
3
+##' @importMethodsFrom SummarizedExperiment rowData rowData<- colData colData<-
4 4
 ##' @importFrom grDevices dev.flush dev.hold
5 5
 ##' @importFrom graphics Axis box mtext par points rect strwidth text
6 6
 ##' @importFrom methods is
... ...
@@ -12,6 +12,7 @@
12 12
 ##' @importFrom ggplot2 geom_segment scale_x_continuous scale_y_continuous
13 13
 ##' @importFrom ggplot2 sec_axis geom_boxplot geom_violin element_text
14 14
 ##' @importFrom patchwork plot_layout
15
+##' @importFrom stats as.formula
15 16
 ##' @importFrom limma normalizeCyclicLoess lmFit eBayes topTable makeContrasts
16 17
 ##'   contrasts.fit
17 18
 
... ...
@@ -95,9 +95,9 @@ Function to make a comparisons between two groups in study samples with a
95 95
 \details{
96 96
 This function provides a simplified interface of fitting a linear model to
97 97
 make a comparison of interest using the \link[limma:lmFit]{limma::lmFit}, \link[limma:ebayes]{limma::eBayes}, and
98
-\link[limma:toptable]{limma::topTable} functions. For more flexible model specification (e.g.,
98
+\link[limma:toptable]{limma::topTable} functions. For more flexible model specifications (e.g.,
99 99
 interaction model, multi-level model), please use a standard workflow
100
-outlined in the \code{limma} package manual.
100
+outlined in the \code{limma} package user's guide.
101 101
 }
102 102
 \examples{
103 103
 
... ...
@@ -6,7 +6,7 @@
6 6
 \alias{qmtools-package}
7 7
 \title{qmtools: Quantitative Metabolomics Data Processing Tools}
8 8
 \description{
9
-The qmtools (quantitative metabolomics tools) package provides basic tools for processing quantitative metabolomics data with the standard SummarizedExperiment class. This includes functions for imputation, normalization, feature filtering, feature clustering, dimension-reduction, and visualization to help users prepare data for statistical analysis. Several functions in this package could also be used in other types of omics data.
9
+The qmtools (quantitative metabolomics tools) package provides basic tools for processing quantitative metabolomics data with the standard SummarizedExperiment class. This includes functions for imputation, normalization, feature filtering, feature clustering, dimension-reduction, and visualization to help users prepare data for statistical analysis. This package also offers a convenient way to compute empirical Bayes statistics for which metabolic features are different between two sets of study samples. Several functions in this package could also be used in other types of omics data.
10 10
 }
11 11
 \details{
12 12
 The qmtools package provides six categories of important functions: