Skip to content

Commit

Permalink
Merge pull request #283 from Open-Systems-Pharmacology/develop
Browse files Browse the repository at this point in the history
Version 1.3
  • Loading branch information
Yuri05 authored May 19, 2022
2 parents c0d8f97 + ccf3ff9 commit 2d63b8f
Show file tree
Hide file tree
Showing 764 changed files with 67,932 additions and 5,757 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@
^tests/dev
^\.covrignore$
^doc$
^docs$
^Meta$
36 changes: 18 additions & 18 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: tlf
Type: Package
Title: TLF Library
Version: 1.1.0
Version: 1.3.0
Authors@R:
c(person(given = "Open-Systems-Pharmacology Community",
role = "cph"),
Expand All @@ -25,55 +25,51 @@ BugReports: https://github.com/open-systems-pharmacology/tlf-library/issues
Imports:
ggplot2 (>= 3.3.0),
R6,
reshape2
jsonlite,
ospsuite.utils,
patchwork
Depends:
R (>= 3.5)
R (>= 3.6)
Encoding: UTF-8
RoxygenNote: 7.1.1
RoxygenNote: 7.1.2
Roxygen: list(markdown = TRUE)
LazyData: true
Suggests:
knitr,
rmarkdown,
testthat (>= 2.1.0),
pander,
gridExtra
testthat (>= 2.1.0)
VignetteBuilder: knitr
Collate:
'enum.R'
'aaa-utilities.R'
'aggregation-input.R'
'aggregation-summary.R'
'atom-plots.R'
'boxwhisker-datamapping.R'
'boxwhisker-get-measure.R'
'boxwhisker-plot.R'
'boxwhisker-plotconfiguration.R'
'data-description.R'
'datamapping-grouping.R'
'datamapping-groupmapping.R'
'datamapping-range.R'
'datamapping-xy.R'
'datamapping-xygroup.R'
'ddiratio-datamapping.R'
'ddiratio-plotconfiguration.R'
'error-checks.R'
'utils.R'
'font.R'
'histogram-datamapping.R'
'histogram-plotconfiguration.R'
'label.R'
'messages.R'
'metadata-helper.R'
'obs-vs-pred-datamapping.R'
'obs-vs-pred-plotconfiguration.R'
'observed-data-mapping.R'
'pkratio-datamapping.R'
'pkratio-get-measure.R'
'pkratio-plotconfiguration.R'
'plot-boxwhisker.R'
'plot-ddiratio.R'
'plot-grid.R'
'plot-histogram.R'
'plot-obs-vs-pred.R'
'plot-pkratio.R'
'plot-res-vs-pred.R'
'plot-timeprofile.R'
'plot-tornado.R'
'plotconfiguration-axis.R'
'plotconfiguration-background.R'
'plotconfiguration-export.R'
Expand All @@ -83,11 +79,15 @@ Collate:
'themes.R'
'timeprofile-datamapping.R'
'timeprofile-helper.R'
'timeprofile-plotconfiguration.R'
'tlf-env.R'
'tornado-datamapping.R'
'tornado-plotconfiguration.R'
'utilities-aesthetics.R'
'utilities-axis.R'
'utilities-background.R'
'utilities-export.R'
'utilities-label.R'
'utilities-legend.R'
'utilities-mapping.R'
'utilities-theme.R'
'utils.R'
64 changes: 54 additions & 10 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,26 @@ export("median+1.5IQR")
export("median+IQR")
export("median-1.5IQR")
export("median-IQR")
export(AestheticProperties)
export(AestheticSelectionKeys)
export(AggregationInput)
export(AggregationSummary)
export(Alignments)
export(AxisConfiguration)
export(BackgroundConfiguration)
export(BackgroundElementConfiguration)
export(BackgroundElement)
export(BoxWhiskerDataMapping)
export(BoxWhiskerPlotConfiguration)
export(CaptionProperties)
export(ColorMaps)
export(DDIComparisonTypes)
export(DDIRatioDataMapping)
export(DDIRatioPlotConfiguration)
export(ExportConfiguration)
export(ExportFormats)
export(ExportUnits)
export(Font)
export(FontFaces)
export(GroupMapping)
export(Grouping)
export(HistogramDataMapping)
Expand All @@ -47,18 +56,30 @@ export(LabelConfiguration)
export(LegendConfiguration)
export(LegendPositions)
export(LegendTypes)
export(LineElement)
export(Linetypes)
export(ObsVsPredDataMapping)
export(ObsVsPredPlotConfiguration)
export(ObservedDataMapping)
export(PKRatioDataMapping)
export(PKRatioPlotConfiguration)
export(PlotConfiguration)
export(PlotGridConfiguration)
export(RangeDataMapping)
export(ResVsPredDataMapping)
export(ResVsPredPlotConfiguration)
export(Scaling)
export(Shapes)
export(Theme)
export(ThemeAesProperties)
export(ThemeAestheticMaps)
export(ThemeAestheticSelections)
export(ThemeBackground)
export(ThemeFont)
export(ThemePlotConfigurations)
export(TimeProfileDataMapping)
export(TimeProfilePlotConfiguration)
export(TornadoDataMapping)
export(TornadoPlotConfiguration)
export(XAxisConfiguration)
export(XYDataMapping)
export(XYGDataMapping)
Expand All @@ -69,25 +90,37 @@ export(addRibbon)
export(addScatter)
export(addWatermark)
export(asLabel)
export(bigTheme)
export(bwTheme)
export(createWatermarkGrob)
export(defaultTheme)
export(exportPlot)
export(exportPlotConfigurationCode)
export(getBoxWhiskerMeasure)
export(getDefaultCaptions)
export(getGuestValues)
export(getGuestValuesFromDataMapping)
export(getLabelWithUnit)
export(getLegendCaption)
export(getLegendPosition)
export(getLnTickLabels)
export(getLogTickLabels)
export(getPKRatioMeasure)
export(getSqrtTickLabels)
export(initializePlot)
export(metaDataHelper)
export(loadThemeFromJson)
export(plotBoxWhisker)
export(plotDDIRatio)
export(plotGrid)
export(plotHistogram)
export(plotObsVsPred)
export(plotPKRatio)
export(plotResVsPred)
export(plotTimeProfile)
export(plotTornado)
export(runPlotMaker)
export(runThemeMaker)
export(saveThemeToJson)
export(setBackground)
export(setBackgroundPanelArea)
export(setBackgroundPlotArea)
export(setCaptionColor)
export(setCaptionFill)
export(setCaptionLabels)
Expand All @@ -99,26 +132,37 @@ export(setCaptionVisibility)
export(setDefaultAggregationBins)
export(setDefaultAggregationFunctions)
export(setDefaultAggregationLabels)
export(setDefaultExportName)
export(setDefaultExportParameters)
export(setDefaultLegendPosition)
export(setDefaultLogTicks)
export(setDefaultWatermark)
export(setFontProperties)
export(setGrid)
export(setLegend)
export(setLegendCaption)
export(setLegendFont)
export(setLegendPosition)
export(setLegendTitle)
export(setPlotExport)
export(setPlotExportDimensions)
export(setPlotExportFormat)
export(setPlotExportSize)
export(setPlotLabels)
export(setWatermark)
export(setXAxis)
export(setXGrid)
export(setYAxis)
export(setYGrid)
export(tlfStatFunctions)
export(tlfTheme)
export(updateLegendCaption)
export(updateExportDimensionsForLegend)
export(updateTimeProfileLegend)
export(useDarkTheme)
export(useExcelTheme)
export(useHighChartTheme)
export(useMatlabTheme)
export(useMinimalTheme)
export(useTemplateTheme)
export(useTheme)
import(ggplot2)
import(jsonlite)
import(ospsuite.utils)
import(utils)
58 changes: 32 additions & 26 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,43 @@
# TLF Library Release Notes
# tlf 1.3.0

# Version 0.1.0 for alpha-testing
## New features

# December 3rd, 2019
* New function `plotGrid()` to create a plot grid and `PlotGridConfiguration` class to specify its properties.
* The default theme for all plots is the new `useMinimalTheme()`.

# Overview
The `tlf` library is an R package compatible with the `ospsuite` package.
`tlf` provides an environment to create standardized plots and tables out of output extracted from the `ospsuite`.
The following release notes aim at presenting the features of the `tlf` library alpha release and how to report feedback.
# tlf 1.2.0

# New features
## PK Ratios Plots
Users can plot PK Ratios associated with the predefined ratio limits through the function `plotPKRatio`.
They can also get the measure of how many of these ratios were in the predefined ratio limits through the function `getPKRatioMeasure`.
## New features

## Time Profiles Plots
Users can plot time profiles through the function `plotTimeProfile`.
* The concept of `Theme` objects was updated and themes can be loaded and saved through json files.
* New plot, `plotTornado`, added to available plots
* Update of `plotTimeProfile` splitting input data to pair *data* with *observedData*
* Creation of two shiny apps:
* `runThemeMaker()`: create and save `Theme` objects
* `runPlotMaker()`: import your data, create and edit their plot

## Histograms
Users can plot histograms through the function `plotHistogram`.
## Minor improvements and bug fixes

## Box Whiskers
Users can plot box whiskers through the function `plotBoxWhisker`.
* Creation of enum objects providing shortkeys for plot properties: `Shapes`, `Linetypes`, `Scaling`, `LegendPositions`
* `{tlf}` now encourages using `{patchwork}` package to create a grid of plots instead of `{gridExtra}`.

## Plot Configuration
Users can create and use standardized plots by setting their configuration using `Theme` and `PlotConfiguration`.
These configurations allows easy definitions of labels, background and axes properties.
# tlf 1.1.0

## Overview
The `tlf` library is an R package compatible with the `ospsuite` package.
`tlf` provides an environment to create standardized plots and tables out of output extracted from the `ospsuite`.
The following release notes aim at presenting the features of the `tlf` library alpha release and how to report feedback.

# How to test the `tlf` library
Five tutorials explaining how to use the objects and functions from the `tlf` library are accessible through vignettes.
Use `browseVignettes(package = "tlf")` to access all vignettes tutorials.
To test the new features, data are already saved within the library and can be used directly.
For PK ratios, the data and its related metadata are called: `pkRatioData` and `pkRatioMetaData`.
## New features

* New plots available:
* PK Ratio Plots: Users can plot PK Ratios associated with the predefined ratio limits through the function `plotPKRatio`.
They can also get the measure of how many of these ratios were in the predefined ratio limits through the function `getPKRatioMeasure`.
* Users can plot time profiles through the function `plotTimeProfile`.
* Histograms: Users can plot histograms through the function `plotHistogram`.
* Box Whiskers: Users can plot box whiskers through the function `plotBoxWhisker`.
* Plot Configuration: Users can create and use standardized plots by setting their configuration using `Theme` and `PlotConfiguration`.
These configurations allows easy definitions of labels, background and axes properties.

# Report feedback
Users can report feedback and bugs through Github forum and issues at: https://github.com/open-systems-pharmacology/tlf-library/issues
Users can report feedback and bugs through Github forum and issues at: https://github.com/open-systems-pharmacology/tlf-library/issues
Loading

0 comments on commit 2d63b8f

Please sign in to comment.