This PR aims to explain that rarefyAssay returns a new SummarizedExperiment object that includes the original counts assay and the newly added subsampled assay. The goal is that the user is not mistaken thinking that the subsampled assay replaces the original counts assay.
It was already mentioned at the line documenting the name parameter but I tried to make it clearer.
This PR aims to explain that
rarefyAssayreturns a newSummarizedExperimentobject that includes the originalcountsassay and the newly added subsampled assay. The goal is that the user is not mistaken thinking that the subsampled assay replaces the originalcountsassay.It was already mentioned at the line documenting the
nameparameter but I tried to make it clearer.