From 04e1d25416aa4669c3417085db3c6c512620240a Mon Sep 17 00:00:00 2001 From: jtlandis Date: Sat, 4 Jan 2025 01:50:02 -0500 Subject: [PATCH] No idea why there are some diffs in this file. oh well :shrug: --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e1be625..50d0106 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ interface to *SummarizedExperiment*. These two packages can easily be used in parallel, by casting objects with the `new_plyxp` constructor to enable `plxyp`-driven functionality. -`plyxp` uses -[data-masking](https://rlang.r-lib.org/reference/topic-data-mask-programming.html) +`plyxp` uses +[data-masking](https://rlang.r-lib.org/reference/topic-data-mask-programming.html) from the `rlang` package in order to connect dplyr functions to *SummarizedExperiment* slots in a manner that aims to be intuitive and avoiding ambiguity in outcomes. @@ -24,13 +24,14 @@ out to the package developers, see *Feedback* section below. ## installing `plyxp` ```r +# plyxp is available on BiocManager version 3.20 BiocManager::install("plyxp") ``` # data masking `SummarizedExperiment` \ -The `SummarizedExperiment` object contains three main components/"contexts" that we mask, +The `SummarizedExperiment` object contains three main components/"contexts" that we mask, the `assays()`, `rowData()`[^1] and `colData()`. [^1]: At this moment `rowRanges()` is not supported in `plyxp` but may become @@ -39,33 +40,33 @@ its own pronoun in the future. ![Simplified view of data masking structure. Figure made with [Biorender](https://biorender.com)](man/figures/Overview-bindings.png) \ -`plyxp` provides variables as-is to data **within their current contexts** enabling you +`plyxp` provides variables as-is to data **within their current contexts** enabling you to call S4 methods on S4 objects with `dplyr` verbs. If you require access to -variables _outside the context_, you may use -pronouns made available through `plyxp` to specify where to find those +variables _outside the context_, you may use +pronouns made available through `plyxp` to specify where to find those variables. ![Simplified view of reshaping pronouns. Arrows indicates to where the pronoun provides access. For each pronoun listed, there is an `_asis` variant that returns underlying data without reshaping it to fit the context. Figure made with [Biorender](https://biorender.com)](man/figures/Overview-pronouns.png) \ -The `.assays`, `.rows` and `.cols` pronouns outputs depends on the evaluating +The `.assays`, `.rows` and `.cols` pronouns outputs depends on the evaluating context. Users should expect that the underlying data returned from `.rows` or -`.cols` pronouns in the _**assays context**_ is a vector, replicated to match +`.cols` pronouns in the _**assays context**_ is a vector, replicated to match size of the assay context. \ -Alternatively, using a pronoun in either the `rows()` or `cols()` +Alternatively, using a pronoun in either the `rows()` or `cols()` contexts will likely return a list equal in length to either `nrows(rowData())` -or `nrows(colData())`. +or `nrows(colData())` respectively. # Feedback -We would love to hear your feedback. Please post to +We would love to hear your feedback. Please post to [Bioconductor support site](https://support.bioconductor.org) -or the +or the `#tidiness_in_bioc` Slack channel on community-bioc -for software usage help, -or post an +for software usage help, +or post an [Issue on GitHub](https://github.com/jtlandis/plyxp/issues), for software development questions.