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

Closes #210 clean documentation #211

Merged
merged 4 commits into from
Dec 14, 2021

Conversation

pchelle
Copy link
Collaborator

@pchelle pchelle commented Dec 14, 2021

No description provided.

@Yuri05
Copy link
Member

Yuri05 commented Dec 14, 2021

@pchelle As this PR is on documentation: there are still a few warnings in the build log:

 checking for missing documentation entries ... WARNING
Undocumented code objects:
  'Percentile0%' 'Percentile1%' 'Percentile10%' 'Percentile100%'
  'Percentile15%' 'Percentile2.5%' 'Percentile20%' 'Percentile25%'
  'Percentile25%-1.5IQR' 'Percentile5%' 'Percentile50%' 'Percentile75%'
  'Percentile75%+1.5IQR' 'Percentile80%' 'Percentile85%'
  'Percentile90%' 'Percentile95%' 'Percentile97.5%' 'Percentile99%'
  'mean+1.96sd' 'mean+sd' 'mean-1.96sd' 'mean-sd' 'median+1.5IQR'
  'median+IQR' 'median-1.5IQR' 'median-IQR'
All user-level objects in a package should have documentation entries.
See chapter 'Writing R documentation files' in the 'Writing R
Extensions' manual.
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... WARNING
Documented arguments not in \usage in documentation object 'getLegendCaption':
  'captionData' 'which'
Functions with \usage entries need to have the appropriate \alias
entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
See chapter 'Writing R documentation files' in the 'Writing R
Extensions' manual.

@codecov-commenter
Copy link

Codecov Report

Merging #211 (e2f393a) into develop (630ab34) will increase coverage by 0.65%.
The diff coverage is 100.00%.

❗ Current head e2f393a differs from pull request most recent head ab01ca3. Consider uploading reports for the commit ab01ca3 to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #211      +/-   ##
===========================================
+ Coverage    47.06%   47.72%   +0.65%     
===========================================
  Files           57       56       -1     
  Lines         2624     2588      -36     
===========================================
  Hits          1235     1235              
+ Misses        1389     1353      -36     
Impacted Files Coverage Δ
R/aggregation-input.R 90.69% <ø> (ø)
R/atom-plots.R 77.46% <ø> (ø)
R/boxwhisker-datamapping.R 0.00% <ø> (ø)
R/boxwhisker-get-measure.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 30 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 630ab34...ab01ca3. Read the comment docs.

@Yuri05 Yuri05 merged commit 81d10cf into Open-Systems-Pharmacology:develop Dec 14, 2021
@pchelle pchelle deleted the 210-clean-doc branch February 15, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants