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

Version 1.3 #283

Merged
merged 79 commits into from
May 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
79 commits
Select commit Hold shift + click to select a range
c7040f1
Draft first version for tornado plot
pchelle Jan 8, 2021
acc757f
Include shortcut to allow for sorting in the plot
pchelle Jan 19, 2021
d441c46
Adapt tornado plot to theme properties
pchelle Jan 19, 2021
9592293
Add some tests about the tornado plot
pchelle Jan 19, 2021
a91476d
Include error bar atom plot
pchelle Jan 19, 2021
5fff38b
Include some tests for atom plots
pchelle Jan 19, 2021
a85b75a
Add some examples in dev for users
pchelle Jan 19, 2021
f465e1a
Fix typo in tests
pchelle Jan 19, 2021
24c309b
Merge pull request #136 from pchelle/134-sensitivity-plot
pchelle Feb 4, 2021
2a18623
135 theme concept (#137)
pchelle Mar 18, 2021
e56b1bf
135 theme vignette (#139)
pchelle Apr 14, 2021
0b77348
140 tick size (#142)
pchelle Apr 24, 2021
7600a01
Fixes #144 "blank" shape is ggplot shape 32 (#145)
pchelle Jun 10, 2021
c30a4d4
147 plot obs vs pred (#148)
pchelle Jul 7, 2021
5109ecc
Fixes #151 use coord_cartesian (#152)
pchelle Jul 28, 2021
4fb1497
Fixes #149 provides a functions to plot res vs pred/time (#155)
pchelle Aug 5, 2021
f6044eb
Fixes #146 provide functions to export plot configuration as R code (…
pchelle Sep 4, 2021
dbaa7a6
housekeeping (#159)
IndrajeetPatil Sep 13, 2021
2541724
Bug fixing osp example (#166)
pchelle Sep 21, 2021
87fc719
add a static website for the package (#167)
IndrajeetPatil Sep 22, 2021
33d222c
168 molecule legend (#169)
pchelle Sep 23, 2021
2fe4f25
closes #164; rebuild website articles
IndrajeetPatil Oct 5, 2021
150a8ba
Merge pull request #172 from IndrajeetPatil/issue_164
IndrajeetPatil Oct 5, 2021
bdd485b
closes #173
IndrajeetPatil Oct 5, 2021
3ce8490
Merge pull request #175 from Open-Systems-Pharmacology/issue_173
IndrajeetPatil Oct 5, 2021
9f84416
adding vignette urls to docs
IndrajeetPatil Oct 12, 2021
be21543
Merge pull request #177 from Open-Systems-Pharmacology/adding_examples
IndrajeetPatil Oct 12, 2021
218c124
closes #174
IndrajeetPatil Oct 12, 2021
9038d95
Merge pull request #180 from Open-Systems-Pharmacology/issue_171
IndrajeetPatil Oct 14, 2021
8b5d53a
Fixes #181 center label when angles are used
pchelle Oct 14, 2021
b29f205
Merge pull request #182 from pchelle/181-center-label
pchelle Oct 14, 2021
82aa7fd
add option for generating guest function outputs for residualVsObserv…
abdullahhamadeh Oct 14, 2021
0df22e1
Complement documentation for atom plots (#185)
pchelle Oct 21, 2021
2631708
Fixes #186 coord_cartesian update both axis limits (#189)
pchelle Nov 4, 2021
9d8e0b2
187 histograms (#188)
pchelle Nov 4, 2021
65b623a
Remove cache (#191)
msevestre Nov 4, 2021
0c2c173
Fixes #192 replace geom_abline by geom_hline for horizontal lines (#193)
pchelle Nov 4, 2021
dcc712e
update website; use bootstrap 5
IndrajeetPatil Nov 9, 2021
f29bb30
Merge pull request #195 from Open-Systems-Pharmacology/update_website…
IndrajeetPatil Nov 9, 2021
5d6a948
closes #173
IndrajeetPatil Nov 9, 2021
29f2739
Merge pull request #196 from Open-Systems-Pharmacology/fix_vignette_i…
IndrajeetPatil Nov 9, 2021
aea83b9
add option for residual vs observed ddi ratio horizontal line (#194)
abdullahhamadeh Nov 9, 2021
5a3293b
adds github actions (#197)
IndrajeetPatil Nov 9, 2021
36b42cc
minor
IndrajeetPatil Nov 9, 2021
f6e5f9c
remove unused docs folder with website
IndrajeetPatil Nov 9, 2021
0cb7c35
turn off dark mode
IndrajeetPatil Nov 9, 2021
4384bc5
turn off dark mode 2
IndrajeetPatil Nov 9, 2021
46cee6a
Fixes #199 Fixes #154 use log ticks and log labels (#201)
pchelle Nov 23, 2021
b1eb95b
fixes #203 Add artifacts without version number to enable usage as pe…
Yuri05 Nov 26, 2021
d1c04b1
Set of predifined themes (#205)
pchelle Dec 6, 2021
630ab34
Fixes #207 Remove unwanted vertical bars from errorbars legend (#208)
pchelle Dec 10, 2021
81d10cf
Closes #210 clean documentation (#211)
pchelle Dec 14, 2021
1aa644f
112 time profile doc (#212)
pchelle Dec 17, 2021
6434184
209 use ospsuite utils (#213)
pchelle Dec 21, 2021
fe4eac2
Fixes #206 restore vignette image files (#215)
pchelle Jan 26, 2022
eca81b4
Fixes #220 expressions are check first when creating plot ticks (#221)
pchelle Feb 24, 2022
4eea999
updating git submodule; closes #184 (#219)
IndrajeetPatil Feb 24, 2022
0b41133
remove unused reshape2 dependency; bump R version (#226)
IndrajeetPatil Mar 14, 2022
5379e02
Fixes #227 ribbon transparency can be changed in all plots (#228)
pchelle Mar 24, 2022
e412f52
224 time profile mapping (#229)
pchelle Mar 24, 2022
5bb0219
223 minimal theme by default (#233)
pchelle Mar 31, 2022
75c0346
231 transparent legend keys (#232)
pchelle Mar 31, 2022
ee2e431
216 language settings (#240)
pchelle Apr 13, 2022
389aadf
237 export configuration (#239)
pchelle Apr 20, 2022
52f14e0
234 alignment (#244)
pchelle Apr 22, 2022
dd00853
move plot grid function and class from ospsuite (#246)
IndrajeetPatil Apr 23, 2022
7602df3
Add default color map for ospsuite plots (#247)
IndrajeetPatil Apr 26, 2022
aa82c2e
Fixes #245 allow transparency for lines and points (#250)
pchelle Apr 29, 2022
2cbd8ad
Fixes #249 allow data expansion to axes (#251)
pchelle May 2, 2022
02169e3
Fixes #252 by default labels are centered (#258)
pchelle May 4, 2022
9db9115
Fixes #254 diamond later in Shapes enum (#257)
pchelle May 4, 2022
8cfe7bc
Fixes #255 all aesthetics are updated in time profile plots (#256)
pchelle May 5, 2022
4c25a51
Fixes #248 include caption in LabelConfiguration (#259)
pchelle May 5, 2022
486187b
Fixes #263 add enum helpers for units and format (#266)
pchelle May 12, 2022
c346b0c
add `$addPlots()` method to `PlotGridConfiguration` (#269)
IndrajeetPatil May 12, 2022
30e8b25
Fixes #253 default expand for ddi ratio and other plot configurations…
pchelle May 12, 2022
7d1e115
Fixes #264 Avoid manual update for the caption of time profile plot (…
pchelle May 18, 2022
3613aa2
Add manual website in docs folder (#276)
IndrajeetPatil May 19, 2022
ccf3ff9
Bump package version; update NEWS (#277)
IndrajeetPatil May 19, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
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