Skip to content

Commit 5557add

Browse files
committed
Update README and Introduction vignette to enhance package overview and clarify display features for SummarizedExperiment objects. Removed deprecated visualizations and streamlined content for better accessibility and user experience.
1 parent 8921f3a commit 5557add

File tree

2 files changed

+2
-97
lines changed

2 files changed

+2
-97
lines changed

README.md

Lines changed: 1 addition & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,7 @@ visualization and user experience when working with genomic data.
4646

4747
### Package Overview
4848

49-
To facilitate the discussion about data display, we compare here four
50-
data displays:
51-
52-
1. **SummarizedExperiment**: Standard R/SummarizedExperiment printing
53-
style.
54-
55-
2. **tidyprint_1**: Newly designed tibble abstraction, combines styles
56-
from **tidySummarizedExperiment** and **plyxp** with updated design.
57-
58-
Depending on your workflow and desired console output, `tidyprint` makes
59-
it easy to switch between these printing styles.
49+
**tidyprint** provides an improved display for SummarizedExperiment objects with a tidy tibble-style format that makes genomic data more accessible and easier to explore.
6050

6151
------------------------------------------------------------------------
6252

@@ -145,65 +135,6 @@ airway
145135
#> # seq_name <chr>, seq_strand <chr>, seq_coord_system <chr>, symbol <chr>
146136
```
147137

148-
------------------------------------------------------------------------
149-
150-
**For comparative purposes we display the alternative visualisations we
151-
are trying to harmonise (now depreciated)**
152-
153-
### **tidySummarizedExperiment**
154-
155-
Use the “tidySummarizedExperiment” design to view your data in a
156-
**tidy-friendly tibble** format:
157-
158-
``` r
159-
# Tidy SummarizedExperiment print:
160-
airway %>% print(design = "tidySummarizedExperiment")
161-
#> # A SummarizedExperiment-tibble abstraction: 509,416 × 23
162-
#> # Features=63677 | Samples=8 | Assays=counts
163-
#> .feature .sample counts SampleName cell dex albut Run avgLength
164-
#> <chr> <chr> <int> <fct> <fct> <fct> <fct> <fct> <int>
165-
#> 1 ENSG00000000003 SRR10395… 679 GSM1275862 N613… untrt untrt SRR1… 126
166-
#> 2 ENSG00000000005 SRR10395… 0 GSM1275862 N613… untrt untrt SRR1… 126
167-
#> 3 ENSG00000000419 SRR10395… 467 GSM1275862 N613… untrt untrt SRR1… 126
168-
#> 4 ENSG00000000457 SRR10395… 260 GSM1275862 N613… untrt untrt SRR1… 126
169-
#> 5 ENSG00000000460 SRR10395… 60 GSM1275862 N613… untrt untrt SRR1… 126
170-
#> 6 ENSG00000000938 SRR10395… 0 GSM1275862 N613… untrt untrt SRR1… 126
171-
#> 7 ENSG00000000971 SRR10395… 3251 GSM1275862 N613… untrt untrt SRR1… 126
172-
#> 8 ENSG00000001036 SRR10395… 1433 GSM1275862 N613… untrt untrt SRR1… 126
173-
#> 9 ENSG00000001084 SRR10395… 519 GSM1275862 N613… untrt untrt SRR1… 126
174-
#> 10 ENSG00000001167 SRR10395… 394 GSM1275862 N613… untrt untrt SRR1… 126
175-
#> # ℹ 40 more rows
176-
#> # ℹ 14 more variables: Experiment <fct>, Sample <fct>, BioSample <fct>,
177-
#> # gene_id <chr>, gene_name <chr>, entrezid <int>, gene_biotype <chr>,
178-
#> # gene_seq_start <int>, gene_seq_end <int>, seq_name <chr>, seq_strand <int>,
179-
#> # seq_coord_system <int>, symbol <chr>, GRangesList <list>
180-
```
181-
182-
### **plyxp**
183-
184-
For a more compact view (top and bottom rows), similar to a
185-
plyxp/tidyverse style:
186-
187-
``` r
188-
airway %>% print(design = "plyxp")
189-
#> # A tibble: 10 × 25
190-
#> .features .samples `|` counts `|` gene_id gene_name entrezid gene_biotype
191-
#> <chr> <chr> <|> <int> <|> <chr> <chr> <int> <chr>
192-
#> 1 ENSG0000… SRR1039… | 679 | ENSG000000… TSPAN6 NA protein_cod…
193-
#> 2 ENSG0000… SRR1039… | 0 | ENSG000000… TNMD NA protein_cod…
194-
#> 3 ENSG0000… SRR1039… | 467 | ENSG000000… DPM1 NA protein_cod…
195-
#> 4 ENSG0000… SRR1039… | 260 | ENSG000000… SCYL3 NA protein_cod…
196-
#> 5 ENSG0000… SRR1039… | 60 | ENSG000000… C1orf112 NA protein_cod…
197-
#> 6 ENSG0000… SRR1039… | 0 | ENSG000002… RP11-180… NA antisense
198-
#> 7 ENSG0000… SRR1039… | 0 | ENSG000002… TSEN34 NA protein_cod…
199-
#> 8 ENSG0000… SRR1039… | 0 | ENSG000002… RP11-138… NA lincRNA
200-
#> 9 ENSG0000… SRR1039… | 0 | ENSG000002… AP000230… NA lincRNA
201-
#> 10 ENSG0000… SRR1039… | 0 | ENSG000002… RP11-80H… NA lincRNA
202-
#> # ℹ 16 more variables: gene_seq_start <int>, gene_seq_end <int>,
203-
#> # seq_name <chr>, seq_strand <int>, seq_coord_system <int>, symbol <chr>,
204-
#> # `|` <|>, SampleName <fct>, cell <fct>, dex <fct>, albut <fct>, Run <fct>,
205-
#> # avgLength <int>, Experiment <fct>, Sample <fct>, BioSample <fct>
206-
```
207138

208139
## Messaging function
209140

vignettes/Introduction.Rmd

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -77,13 +77,7 @@ find_figure <- function(names){
7777

7878
### Package Overview
7979

80-
To facilitate the discussion about data display, we compare here four data displays:
81-
82-
1. **SummarizedExperiment**: Standard R/SummarizedExperiment printing style.
83-
84-
2. **tidyprint_1**: Newly designed tibble abstraction, combines styles from **tidySummarizedExperiment** and **plyxp** with updated design.
85-
86-
Depending on your workflow and desired console output, `tidyprint` makes it easy to switch between these printing styles.
80+
**tidyprint** provides an improved display for SummarizedExperiment objects with a tidy tibble-style format that makes genomic data more accessible and easier to explore.
8781

8882
------------------------------------------------------------------------
8983

@@ -141,26 +135,6 @@ library(tidyprint)
141135
airway
142136
```
143137

144-
------------------------------------------------------------------------
145-
146-
**For comparative purposes we display the alternative visualisations we are trying to harmonise (now depreciated)**
147-
148-
### **tidySummarizedExperiment**
149-
150-
Use the "tidySummarizedExperiment" design to view your data in a **tidy-friendly tibble** format:
151-
152-
```{r tidyse-display}
153-
# Tidy SummarizedExperiment print:
154-
airway %>% print(design = "tidySummarizedExperiment")
155-
```
156-
157-
### **plyxp**
158-
159-
For a more compact view (top and bottom rows), similar to a plyxp/tidyverse style:
160-
161-
```{r plyxp-display}
162-
airway %>% print(design = "plyxp")
163-
```
164138

165139
## Messaging function
166140

0 commit comments

Comments
 (0)