Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix R cmd check --as-cran #730

Merged
merged 1 commit into from
Sep 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Authors@R: c(
person("F. Hoffmann-La Roche AG", role = c("cph", "fnd")),
person("Maximilian", "Mordig", role = "ctb")
)
Description: teal is a shiny based interactive exploration framework for
Description: A shiny based interactive exploration framework for
analyzing clinical trials data. teal currently provides a dynamic
filtering facility and different data viewers. teal shiny applications
are built using standard shiny modules.
Expand Down
5 changes: 3 additions & 2 deletions R/module_tabs_with_filters.R
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@
#' @keywords internal
#'
#' @examples
#'
#' mods <- teal:::get_dummy_modules()
#' datasets <- teal:::get_dummy_datasets()
#'
#' app <- shinyApp(
#' ui = function() {
#' tagList(
Expand Down Expand Up @@ -54,8 +56,7 @@
#'
#'
#' # An example with two filter panels in two apps side-by-side
#' mods <- teal:::get_dummy_modules()
#' datasets1 <- datasets2 <- teal:::get_dummy_datasets()
#' datasets1 <- datasets2 <- datasets
#' app <- shinyApp(
#' ui = function() {
#' tagList(
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Teal: Interactive Exploratory Data Analysis with Shiny Web-Applications <a href='https://insightsengineering.github.io/teal'><img src="man/figures/teal.png" align="right" height="139" style="max-width: 100%;"/></a >
# Teal: Interactive Exploratory Data Analysis with Shiny Web-Applications <a href='https://insightsengineering.github.io/teal/'><img src="man/figures/teal.png" align="right" height="139" style="max-width: 100%;"/></a >

*teal* is a shiny-based interactive exploration framework for analyzing data. `teal` applications require app developers to specify:

Expand All @@ -10,22 +10,22 @@
- `MultiAssayExperiment` objects which are R data structures for representing and analyzing multi-omics experiments
- `teal` modules:
- `teal modules` are shiny modules built within the `teal` framework that specify analysis to be performed. For example, it can be a module for exploring outliers in the data, or a module for visualizing the data in line plots. Although these can be created from scratch, lost of `teal` modules have been released and we recommend starting with modules found in the following packages:
- [`teal.modules.general`](https://insightsengineering.github.io/teal.modules.general): general modules for exploring relational/independent/CDISC data
- [`teal.modules.clinical`](https://insightsengineering.github.io/teal.modules.clinical): modules specific to CDISC data and clinical trial reporting
- [`teal.modules.hermes`](https://insightsengineering.github.io/teal.modules.hermes): modules for analyzing `MultiAssayExperiment` objects
- [`teal.modules.general`](https://insightsengineering.github.io/teal.modules.general/): general modules for exploring relational/independent/CDISC data
- [`teal.modules.clinical`](https://insightsengineering.github.io/teal.modules.clinical/): modules specific to CDISC data and clinical trial reporting
- [`teal.modules.hermes`](https://insightsengineering.github.io/teal.modules.hermes/): modules for analyzing `MultiAssayExperiment` objects

<!-- markdownlint-enable MD007 MD030 -->

A lot of the functionality of the `teal` framework derives from the following packages:

<!-- markdownlint-disable MD007 MD030 -->
- [`teal.data`](https://insightsengineering.github.io/teal.data): creating and loading the data needed for `teal` applications.
- [`teal.widgets`](https://insightsengineering.github.io/teal.widgets): shiny components used within `teal`.
- [`teal.slice`](https://insightsengineering.github.io/teal.slice): provides a filtering panel to allow filtering of data.
- [`teal.code`](https://insightsengineering.github.io/teal.code): handles reproducibility of outputs.
- [`teal.transform`](https://insightsengineering.github.io/teal.transform): standardizes extracting and merging data.
- [`teal.logger`](https://insightsengineering.github.io/teal.logger): standardizes logging within `teal` framework.
- [`teal.reporter`](https://insightsengineering.github.io/teal.reporter): allows `teal` applications to generate reports.
- [`teal.data`](https://insightsengineering.github.io/teal.data/): creating and loading the data needed for `teal` applications.
- [`teal.widgets`](https://insightsengineering.github.io/teal.widgets/): shiny components used within `teal`.
- [`teal.slice`](https://insightsengineering.github.io/teal.slice/): provides a filtering panel to allow filtering of data.
- [`teal.code`](https://insightsengineering.github.io/teal.code/): handles reproducibility of outputs.
- [`teal.transform`](https://insightsengineering.github.io/teal.transform/): standardizes extracting and merging data.
- [`teal.logger`](https://insightsengineering.github.io/teal.logger/): standardizes logging within `teal` framework.
- [`teal.reporter`](https://insightsengineering.github.io/teal.reporter/): allows `teal` applications to generate reports.

<!-- markdownlint-enable MD007 MD030 -->

Expand All @@ -41,7 +41,7 @@ if (!require("remotes")) install.packages("remotes")
remotes::install_github("insightsengineering/teal@*release")
```

In order to run many of the examples you will also need to install the [`scda`](https://insightsengineering.github.io/scda) package.
In order to run many of the examples you will also need to install the [`scda`](https://insightsengineering.github.io/scda/) package.

A stable release of all `NEST` packages from June 2022 is also available [here](https://github.com/insightsengineering/depository#readme).

Expand Down
5 changes: 3 additions & 2 deletions man/ui_tabs_with_filters.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/including-adam-data-in-teal.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -91,4 +91,4 @@ if (interactive()) {
}
```

For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data).
For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data/).
2 changes: 1 addition & 1 deletion vignettes/including-general-data-in-teal.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ if (interactive()) {
}
```

For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data).
For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data/).
2 changes: 1 addition & 1 deletion vignettes/including-mae-data-in-teal.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ The filter panel supports `MAE` data out of the box, but `teal` itself does not
The package [`teal.modules.hermes`](https://insightsengineering.github.io/teal.modules.hermes/) has been specifically developed for the
analysis of `MAE` data.

For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data).
For more information about preprocessing, reproducibility, relationships between datasets and DDL, please refer to the [`teal.data` package](https://insightsengineering.github.io/teal.data/).