Fix remaining check warnings from PEcAn.logger (fixes #2814) #2815

moki1202 · 2021-06-30T08:28:49Z

this pull request is directed towards getting the logger package ready to be released to CRAN! I will be constantly updating this pull request as we move forward until the task is finished!

moki1202

fixes NOTE - `* checking DESCRIPTION meta-information ... NOTE
Authors@R field gives no person with name and roles.
Authors@R field gives no person with maintainer role, valid email
address and non-empty name.
Author field differs from that derived from Authors@R
Author: ‘Rob Kooper, Alexey Shiklomanov’
Authors@R: ‘’

Maintainer field differs from that derived from Authors@R
Maintainer: ‘Alexey Shiklomanov ashiklom@bu.edu’
Authors@R: ‘’
`

added utils namespace to eliminate NOTE-no visible binding for global variable | similar note remaining for variable "dump.log"!

fixes NOTE- `* checking Rd line widths ... NOTE Rd file 'severeifnot.Rd': \examples lines wider than 100 characters: severeifnot("I absolutely cannot deal with the fact that something is not a list.", is.list(a), is.list(b))`

base/logger/DESCRIPTION

Co-authored-by: Chris Black <chris@ckblack.org>

fix warning - Undocumented arguments in documentation object 'check_conditions' ‘...’

base/logger/DESCRIPTION

base/logger/R/logifnot.R

Co-authored-by: Chris Black <chris@ckblack.org>

moki1202 · 2021-07-03T15:22:34Z

@infotroph same goes for the similar warning in loggergetLevelNumber function? it's also not used anywhere outside logger.R.

moki1202 · 2021-07-03T15:40:43Z

/document

infotroph · 2021-07-03T16:36:54Z

@infotroph same goes for the similar warning in loggergetLevelNumber function? it's also not used anywhere outside logger.R.

Yep, that works! In all three of these cases it also would have worked to leave them as Roxygen comments but add a @noRd tag; which approach is "better" is personal preference and probably depends whether your text editor displays Roxygen comments more or less nicely than plain comments ;)

Fix for note about dump.log

moki1202 · 2021-07-04T07:05:45Z

/document

base/logger/R/logger.R

base/logger/NEWS.md

Co-authored-by: Chris Black <chris@ckblack.org>

base/logger/DESCRIPTION

Co-authored-by: Chris Black <chris@ckblack.org>

infotroph · 2021-07-16T09:27:50Z

/build

infotroph · 2021-07-21T15:04:36Z

This PR is ready to merge. HUGE thanks to @moki1202 for giving us our first PEcAn package that checks fully clean: 0 ERRORs, 0 WARNINGs, 0 NOTEs*, and all historically-ignored messages in Rcheck_reference.log resolved and deleted. More like this, please!

*Technically when you check with --as-cran there's still one NOTE saying who the maintainer is and what license the package has, but this is normal and can only be fixed by... submitting it to CRAN, which is the imminent next step for this package!

Update DESCRIPTION

b9143c6

moki1202 commented Jun 30, 2021

View reviewed changes

moki1202 added 3 commits June 30, 2021 14:04

Update logger.R

0c0bf6a

added utils namespace to eliminate NOTE-no visible binding for global variable | similar note remaining for variable "dump.log"!

Update print2string.R

d89c1e1

Update logifnot.R

67c0bf7

fixes NOTE- `* checking Rd line widths ... NOTE Rd file 'severeifnot.Rd': \examples lines wider than 100 characters: severeifnot("I absolutely cannot deal with the fact that something is not a list.", is.list(a), is.list(b))`

infotroph reviewed Jun 30, 2021

View reviewed changes

base/logger/DESCRIPTION Outdated Show resolved Hide resolved

base/logger/DESCRIPTION Outdated Show resolved Hide resolved

moki1202 and others added 3 commits July 1, 2021 12:07

Update base/logger/DESCRIPTION

9132a97

Co-authored-by: Chris Black <chris@ckblack.org>

Update DESCRIPTION

f697fb0

Update logifnot.R

80ac298

fix warning - Undocumented arguments in documentation object 'check_conditions' ‘...’

infotroph changed the title ~~fixes #2814 | fix every note, warning, error from the R CMD check~~ Fix R CMD check warnings from PEcAn.logger (fixes #2814) Jul 3, 2021

infotroph changed the title ~~Fix R CMD check warnings from PEcAn.logger (fixes #2814)~~ Fix remaining check warnings from PEcAn.logger (fixes #2814) Jul 3, 2021

Merge branch 'develop' into patch-14

79726d2

infotroph requested changes Jul 3, 2021

View reviewed changes

moki1202 and others added 10 commits July 3, 2021 20:00

Update base/logger/DESCRIPTION

da84d6b

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

cfd1680

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

f1b6c26

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

3efa320

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

b8f3de7

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

1e9b1b4

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logifnot.R

df4873d

Co-authored-by: Chris Black <chris@ckblack.org>

Delete check_conditions.Rd

f0427a7

Delete is_definitely_true.Rd

b4b380e

Update base/logger/R/logifnot.R

a9e9e15

Co-authored-by: Chris Black <chris@ckblack.org>

moki1202 added 2 commits July 3, 2021 21:08

changed roxygen comments to R comments

0716cd2

Update logifnot.R

c9baaf4

automated documentation update

548c1a0

quiet note about dump.log

4bde110

infotroph and others added 3 commits July 3, 2021 23:29

add myself as contributor, fix link

f4d4f28

Update DESCRIPTION

cbeab65

Merge pull request #4 from infotroph/logger-check-tweaks

7bc8820

Fix for note about dump.log

Create NEWS.md

358c953

infotroph reviewed Jul 4, 2021

View reviewed changes

base/logger/R/logger.R Outdated Show resolved Hide resolved

infotroph reviewed Jul 4, 2021

View reviewed changes

base/logger/NEWS.md Show resolved Hide resolved

moki1202 and others added 2 commits July 4, 2021 15:30

Update base/logger/NEWS.md

05c60c8

Co-authored-by: Chris Black <chris@ckblack.org>

Update base/logger/R/logger.R

c80d222

Co-authored-by: Chris Black <chris@ckblack.org>

infotroph approved these changes Jul 4, 2021

View reviewed changes

moki1202 added 2 commits July 9, 2021 11:59

Update DESCRIPTION

5055e47

Delete Rcheck_reference.log

3c35b4e

infotroph requested changes Jul 15, 2021

View reviewed changes

base/logger/DESCRIPTION Outdated Show resolved Hide resolved

Update base/logger/DESCRIPTION

ae785b1

Co-authored-by: Chris Black <chris@ckblack.org>

infotroph approved these changes Jul 15, 2021

View reviewed changes

infotroph added 2 commits July 15, 2021 11:21

Merge branch 'develop' into patch-14

dc6b1f3

Merge branch 'develop' into patch-14

dd5644e

infotroph marked this pull request as ready for review July 15, 2021 20:40

mdietze merged commit 17c10bc into PecanProject:develop Jul 21, 2021

infotroph mentioned this pull request Jul 21, 2021

make /base/logger (PEcAn.logger ) package CRAN ready #2814

Open

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix remaining check warnings from PEcAn.logger (fixes #2814) #2815

Fix remaining check warnings from PEcAn.logger (fixes #2814) #2815

moki1202 commented Jun 30, 2021

moki1202 left a comment

moki1202 commented Jul 3, 2021 •

edited

moki1202 commented Jul 3, 2021

infotroph commented Jul 3, 2021

moki1202 commented Jul 4, 2021

infotroph commented Jul 16, 2021

infotroph commented Jul 21, 2021

Fix remaining check warnings from PEcAn.logger (fixes #2814) #2815

Fix remaining check warnings from PEcAn.logger (fixes #2814) #2815

Conversation

moki1202 commented Jun 30, 2021

moki1202 left a comment

Choose a reason for hiding this comment

moki1202 commented Jul 3, 2021 • edited

moki1202 commented Jul 3, 2021

infotroph commented Jul 3, 2021

moki1202 commented Jul 4, 2021

infotroph commented Jul 16, 2021

infotroph commented Jul 21, 2021

moki1202 commented Jul 3, 2021 •

edited