-
Notifications
You must be signed in to change notification settings - Fork 16
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
Rewrite README and style code #155
Conversation
styler::style_pkg(filetype = c("R", "Rmd")) Does not affect functionality. Had a style error: > When processing vignettes/bioRad.Rmd: wrong sign in 'by' argument Which is odd, because it does not contain any code
Using usethis::use_readme_rmd()
Running codemetar::write_codemeta()
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure I added comments/review to this PR properly, but the bottom line:
In README.md:
- I made a few edits to the example of height-integrated time series. I want to avoid people averaging mtr's. Instead they should use the time-integrated column mt (accounts properly for the potentially varying time intervals in the time series)
- Thought it would be nice to also include a plot of the height-integrated time series. Added it to the readme, but not yet the figure
regularize_vpts
no longer essential, though without it you do not see the gray bars without data- should we really use tidyverse piping in the examples? I haven't tested yet whether all package functions are compatible
#128 documents another windows-specific issue that some users ran into, which would be good to document together with other known Docker issues |
Will have a look. 👌 Should have let you know to edit the README.Rmd rather that the automatically created README.md. |
I'll include the installation gotchas in #154 and #128 (which still need a summary) in a later PR if that's ok. |
Already included via DESCRIPTION when doing ?bioRad
Sorry I wasn't clear. Without regularizing you don't see data gaps in the plot, it just fills the area between consecutive profiles, even though they may be widely spaced in time during radar downtime. Often that's fine, especially if there is no missing data. Regularizing has the benefit that you specify at which interval you expect profiles, so I can replace periods with missing data with empty profiles, that show up as gray. |
@adokter So, without regularize a data point in the plot is carried through (straight line) until the chart continues? While with regularize, datetimes are added, resulting in more rows (and actual gaps
If yes, than I think it is good to still include Not sure what we should say about or include it in the vpi plot... but my incorrect comment needs to be updated:
|
Yes |
@peterdesmet should I merge this PR? |
I removed my incorrect remark: PR can be merged now. 👌 Might be good to give some more explanation in the regularize_vpts function documentation, explaining its effect on plots. |
Had to make a few additional commits to master, since some commits entered the develop branch instead of this PR request. Also and ran devtools check and rebuilt pkgdown site. Consider 7451eb1 the end of this PR. |
This PR includes updates to prepare for rOpenSci onboarding (#148). The main changes are:
styler
package over the code to clean up whitespace etc.: this is why most R files are updatedcodemeta.json
(for rOpenSci)bioRad.R
andDESCRIPTION
(as discussed in Review README #138)README.md
fromREADME.Rmd
(allows to have code examples)✨New README ✨
The new README now has:
All elements of the original README are included in one way or another, except:
ggmap2
rhdf5
: no longer needed Add biocViews to automatically look for rhdf5 #151?bioRad
What has been added:
@adokter @CeciliaNilsson709 can you review the README to see if it is clear and that especially for the examples I'm not saying something incorrect? 😅