waldronlab / MultiAssayExperiment

Bioconductor package for management of multi-assay data
https://waldronlab.io/MultiAssayExperiment/
69 stars 32 forks source link

package description #211

Closed lgeistlinger closed 7 years ago

lgeistlinger commented 7 years ago

Could the description as displayed on the bioc landing page (http://bioconductor.org/packages/MultiAssayExperiment) which currently reads: “Develop an integrative environment where multiple assays are managed and preprocessed for genomic data analysis” be updated with a bit more informative description such as 2-3 key sentences as compiled from the abstract of the cancer research paper?

lwaldron commented 7 years ago

I fully agree, this sentence is a relic. How about:

MultiAssayExperiment provides a data class and methods for coordinated representation, subsetting, reshaping, and other operations for experiments involving multiple different assays. It integrates any data class satisfying a few basic requirements, including eSet, (Ranged)SummarizedExperiment, matrix, and derived classes. The user interface is based on SummarizedExperiment, but assays may all have different numbers of rows and columns.

LiNk-NY commented 7 years ago

I was going to add something like:

A coordinated representation of, storage of, and operation on
    multiple diverse 'omics experiments on a set of samples or specimen.
    MultiAssayExperiment provides data structures and methods for representing,
    manipulating, and integrating multi-assay experiments, as well as, a
    framework for integrative statistical analysis and visualization.
LiNk-NY commented 7 years ago

I could add the sentence mentioning the different classes that it supports.

lgeistlinger commented 7 years ago

I would keep it simple and also start with a biological motivation. What about these sentences as directly extracted from your manuscript:

Multi-assay experiments, composed of multiple complementary data types for a set of samples, are increasingly commonplace in biomedical research and add layers of complexity to experimental design, data integration, and analysis. The MultiAssayExperiment package implements data structures and methods for representing, manipulating, and integrating multi-assay experiments. This includes efficient construction, extraction, and subsetting of MultiAssayExperiment data structures. These methods are implemented matching Bioconductor user experience by straightforward extending concept and design of single-assay classes such as SummarizedExperiment or ExpressionSet for multi-assay experiments.

lwaldron commented 7 years ago

Some more copy and style editing:

MultiAssayExperiment implements data structures and methods for representing, manipulating, and integrating multi-assay experiments via efficient construction, subsetting, and extraction operations. Methods emulate SummarizedExperiment as closely as possible to provide a familiar Bioconductor user experience, while providing simple and powerful approaches to working with multi-omics data.