+# `teal`: Interactive Exploratory Data Analysis with Shiny Web-Applications
[](https://insightsengineering.github.io/teal/main/unit-test-report/)
@@ -105,7 +105,7 @@ shinyApp(app$ui, app$server)
Please see [`teal.gallery`](https://insightsengineering.github.io/teal.gallery) and [TLG Catalog](https://insightsengineering.github.io/tlg-catalog) to see examples of `teal` apps.
-Please start with the ["Getting Started" article](https://insightsengineering.github.io/teal/latest-tag/articles/teal.html) and then other [package vignettes](https://insightsengineering.github.io/teal/articles/index.html) for more detailed guide.
+Please start with the ["Technical Blueprint" article](https://insightsengineering.github.io/teal/latest-tag/articles/blueprint/index.html), ["Getting Started" article](https://insightsengineering.github.io/teal/latest-tag/articles/teal.html), and then other [package vignettes](https://insightsengineering.github.io/teal/latest-tag/articles/index.html) for more detailed guide.
## Getting help
diff --git a/_pkgdown.yml b/_pkgdown.yml
index f7afd6b568..e0752c788e 100644
--- a/_pkgdown.yml
+++ b/_pkgdown.yml
@@ -6,7 +6,7 @@ template:
navbar:
structure:
- left: [intro, reference, articles, tutorials, news, reports]
+ left: [intro, reference, articles, blueprint, tutorials, news, reports]
right: [search, github]
components:
reports:
@@ -16,33 +16,77 @@ navbar:
href: coverage-report/
- text: Unit test report
href: unit-test-report/
+ blueprint:
+ text: Technical Blueprint
+ menu:
+ - text: About Blueprint
+ href: articles/blueprint/index.html
+ - text: Introduction
+ href: articles/blueprint/intro.html
+ - text: Actors
+ href: articles/blueprint/actors.html
+ - text: Data Flow
+ href: articles/blueprint/dataflow.html
+ - text: Product Map
+ href: articles/blueprint/products_map.html
+ - text: Features
+ navbar: Features
+ - text: "`qenv`"
+ href: articles/blueprint/qenv.html
+ - text: Filter Panel
+ href: articles/blueprint/filter_panel.html
+ - text: Delayed Data Loading (DDL)
+ href: articles/blueprint/ddl.html
+ - text: Module and Encapsulation
+ href: articles/blueprint/module_encapsulation.html
+
github:
icon: fa-github
href: https://github.com/insightsengineering/teal
articles:
- - title: Get Started
- navbar: ~
- contents:
- - teal
- - title: Articles
- navbar: Using teal
- contents:
- - filter-panel
- - teal-options
- - teal-bs-themes
- - title: Articles
- navbar: Data in teal Apps
- contents:
- - including-adam-data-in-teal
- - including-general-data-in-teal
- - including-mae-data-in-teal
- - preprocessing-data
- - title: Articles
- navbar: Extending teal
- contents:
- - creating-custom-modules
- - adding-support-for-reporting
+- title: Get Started
+ navbar: ~
+ contents:
+ - teal
+- title: Using teal
+ navbar: Using teal
+ contents:
+ - filter-panel
+ - teal-options
+ - teal-bs-themes
+- title: Data in teal Apps
+ navbar: Data in teal Apps
+ contents:
+ - including-adam-data-in-teal
+ - including-general-data-in-teal
+ - including-mae-data-in-teal
+ - preprocessing-data
+- title: Extending teal
+ navbar: Extending teal
+ contents:
+ - creating-custom-modules
+ - adding-support-for-reporting
+- title: 📃 Technical Blueprint
+ desc: >
+ The purpose of the blueprint is to aid new developer’s comprehension of the
+ fundamental principles of the `teal` framework. We will explore crucial `teal`
+ concepts such as data flow, actors, and filter panel, among others.
+ contents:
+ - blueprint/index
+ - blueprint/intro
+ - blueprint/actors
+ - blueprint/dataflow
+ - blueprint/products_map
+- title: ""
+ desc: >
+ Features
+ contents:
+ - blueprint/qenv
+ - blueprint/filter_panel
+ - blueprint/ddl
+ - blueprint/module_encapsulation
+
reference:
- title: Core `teal` Functions
diff --git a/inst/WORDLIST b/inst/WORDLIST
index 02f29a34d2..15cd044d4d 100644
--- a/inst/WORDLIST
+++ b/inst/WORDLIST
@@ -1,20 +1,53 @@
+Acknowledgement
ADaM
+adam
+analysing
+bs
+CDISC
+cloneable
+customizable
+dataflow
+Dataflow
+ddl
+DDL
+desc
+dropdown
+env
Forkers
+funder
+Genentech
+github
Hoffmann
+href
+https
+init
+insightsengineering
+io
+mae
MultiAssayExperiment
-TLG
-Theming
-UI
-UIs
-UX
-cloneable
-funder
+navbar
+nesttemplate
omics
pharmaverse
+pre
+Pre
preprocessed
programmatically
+qenv
+rcode
repo
reproducibility
+srv
+summarization
tabsetted
+tdata
+TealReportCard
themer
+Theming
+TLG
+transfered
+UI
+ui
+UIs
uncheck
+UX
diff --git a/man/figures/filterpanel.png b/man/figures/filterpanel.png
new file mode 100644
index 0000000000000000000000000000000000000000..020b6f3fadd493585a1f36a25e589d81993b42d4
GIT binary patch
literal 116824
zcmeFYWmH>T7cRRfI5f}4~tGZIHvgGyCjI6>Y2Ds|k&6#^MD2GKs#9#12Su0ApL(#W?
zwxoo)&GkXdSz9V6E3*k1$xt07m8yEksKySnUm(xYgWSy~QX+MEb#^YQR&qhy2T1%Q
zLkA6YRZ+XiS{Q|nF$@oQ7Yf~MbCQvSQ*zS|=S&q7lO)*s$poI@g6-d9pA!#MX_u