housekeeping

[IndrajeetPatil]

• spell check
• consistently use markdown syntax in roxygen docs
• style code
• vignette chunk label fixes
• minor rephrasing of vignettes
• update roxygen version
• remove unnecessary pander from Suggests
• follow best practices for .Rproject
• get rid of warnings introduced in ggplot2 3.3.3

[codecov-commenter]

Codecov Report

Merging #159 (64376ca) into develop (f6044eb) will increase coverage by 0.00%.
The diff coverage is 23.52%.

@@           Coverage Diff            @@
##           develop     #159   +/-   ##
========================================
  Coverage    48.57%   48.57%           
========================================
  Files           55       55           
  Lines         2530     2532    +2     
========================================
+ Hits          1229     1230    +1     
- Misses        1301     1302    +1     

Impacted Files	Coverage Δ
R/aggregation-input.R	90.69% <ø> (ø)
R/aggregation-summary.R	0.00% <0.00%> (ø)
R/atom-plots.R	80.42% <ø> (ø)
R/boxwhisker-datamapping.R	0.00% <ø> (ø)
R/boxwhisker-plotconfiguration.R	0.00% <ø> (ø)
R/datamapping-grouping.R	84.61% <ø> (ø)
R/datamapping-groupmapping.R	100.00% <ø> (ø)
R/datamapping-range.R	62.06% <ø> (ø)
R/datamapping-xy.R	30.76% <ø> (ø)
R/datamapping-xygroup.R	94.59% <ø> (ø)
... and 35 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6044eb...64376ca. Read the comment docs.

[msevestre]

Some of the changes are more than MD or style... Can you explain what it does?

[msevestre]

@IndrajeetPatil Why those changes?

[IndrajeetPatil]

• fig.align = 'center' Figures aligned to center look better.
• dpi = 300 for better resolution of plots (markdown defaults to dpi = 72, which makes for a poor figure).
• toc = TRUE to have a table of content, which makes it easier to navigate between different sections, which is especially useful if the vignette is long.

[msevestre]

awesome

[msevestre]

@pchelle FYI: Probably something to use for ReportingEngine as well

[pchelle]

Indeed

[IndrajeetPatil]

@msevestre This is a draft PR, btw. When the PR is ready, I will ask for a review. :)

[msevestre]

@msevestre This is a draft PR, btw. When the PR is ready, I will ask for a review. :)

Ok my bad :)

[Yuri05]

please revert ggplot2 version to >=3.3.0
3.3.5 is not supported yet on some systems where tlf must run

[IndrajeetPatil]

@Yuri05 Sure, will do that.

Out of curiosity, what are the systems where this ggplot2 version is not available?
At least on CRAN, I see that the binaries are built for macOS and Windows on oldrel, release, and devel.

[Yuri05]

what are the systems where this ggplot2 version is not available?

ValidR by Mango. R itself and different packages are usually available in some older version.

[IndrajeetPatil]

Now the PR is ready for a review 😅

[PavelBal]

@Yuri05 @msevestre Don't wait for my review to merge, I have no idea about TLF :D

[pchelle]

Out of curiosity, do you use any specific package for spell check of documentation ?
Also, what is the good practice between using \code{} and the back quotes ? (I feel I did not use those properly)

[IndrajeetPatil]

Out of curiosity, do you use any specific package for spell check of documentation?

Yes, I use devtools::spell_check().

Also, what is the good practice between using \code{} and the back quotes? (I feel I did not use those properly)

Not best practice per se, but just a matter of syntactical taste:
If you want to use Rd syntax, it will be \code{}, while markdown syntax would be backticks.
Given the simplicity of markdown syntax, I am assuming that's what we prefer.

[msevestre]

Given the simplicity of markdown syntax, I am assuming that's what we prefer.

yes. we just all assume we had to use the outdated syntax. Md for the WIN