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.

Sign up for GitHub

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

Jump to bottom

Reviewer guide needs more instructions re Suggests #112

Closed
cboettig opened this issue Jan 11, 2019 · 3 comments
Closed

Reviewer guide needs more instructions re Suggests #112

cboettig opened this issue Jan 11, 2019 · 3 comments
Labels
content 📃
Milestone
0.3.0

Comments

@cboettig
Copy link
Member

The guidelines for reviewers should state that reviewers will need to install the review package using install(dependencies=TRUE) (or similar command) to install Suggested packages. It seems pretty common for reviewers to report issues like

✖ fix this R CMD check ERROR: Package suggested but not available: ‘spelling’

as errors to the package author. In general, it can be pretty confusing for newer (and not newer) developers that Suggests is essentially a list of packages needed for testing, I suppose a more detailed discussion of to use Suggests for (and what not to) might also be warranted?
@maelle
Copy link
Member

maelle commented Jan 14, 2019

Good catch! Interested in making a PR? 😺

@maelle maelle mentioned this issue Jan 22, 2019
Merged
@maelle
Copy link
Member

maelle commented Apr 24, 2019 •
edited
Loading

First part of these suggestions has been implemented.

@cboettig regarding your remark about new package developers, what should we add to the current guidance "* Use Imports instead of Depends for packages providing functions from other packages. Make sure to list packages used for testing (testthat), and documentation (knitr, roxygen2) in your Suggests section of package dependencies. If you use any package in the examples or tests of your package, make sure to list it in Suggests, if not already listed in Imports."?

@maelle maelle added this to the 0.3.0 milestone May 1, 2019
@maelle
Copy link
Member

maelle commented Jun 10, 2019

👋 @cboettig, friendly ping reg the above, what do you think is still missing?

maelle added a commit that referenced this issue Jun 11, 2019
@maelle
add mention of usethis functions for adding testing or vignette infra…
b309074 
…structure in the part about dependencies in the package building guide thx @cboettig fix #112
@maelle maelle closed this as completed Jun 11, 2019
sckott pushed a commit that referenced this issue Oct 4, 2019
@maelle @sckott
For comparison until the next release (#160)
0a8f24d 
* update dev (#157)

* draft book release guidance (#152)

* include the book release guidance in the book

* update news

* clarify release guidance

* Remove "click here" link (#166)

* Update all links to HTTPS (#167)

* URLs should be enclosed in angle brackets, e.g. <https://www.r-project.org> (#169)

--https://cran.r-project.org/doc/manuals/r-release/R-exts.html

* Expand on what 'more discoverable' means (#172)

* fix @melvidoni's affiliation in dev too

* new dev guide URL

* add mention of usethis functions for adding testing or vignette infrastructure in the part about dependencies in the package building guide thx @cboettig fix #112

* remove recommendation about `roxygen2` dev version since the latest stable version has what is needed. fix #165 thanks @Bisaloo

* add more details about gitflow

* more direct link to Amanda's write-up

* update ref to R pkg book

* fix #163 now that the book is less new

* Update pkg_building.Rmd (#178)

* Update pkg_building.Rmd

See #151

* Update appendix.Rmd

As requested.

* Update index.Rmd

As requested.

* Rodev mentions (#176)

Fix #48

* CRAN checks explanations (#177)

* Explain CRAN checks

* add that rOpenSci maintains API

Fix #175

* docs.ropensci.org guidance (#162)

fix #164 and cf #155

* fix #155 by improving pkgdown guidance

* suggest R Markdown hunks approach for README and vignette (#161)

* fix #179 by fixing formatting of Appendices B-D in the pdf version of the book

* make NEWs template look ok again cf #179

* fix ref to R packages book

* add link to rOpenSci community call "Security for R" to security chapter cf #154

* Add note about pkgreviewr Rstudio dependency. 

Resolves #183

* Break up reproducibility category into component parts (#184)

- Also increase clarity that software wrappers are for non-R programs
- Re-arrange thematically
- Add appropriate examples

Closes ropensci/software-review-meta#81

* fix #192 update instructions in readme for rendering book locally, _book instead of _output
and updated NEWS

* fix spelling and missing "an" in Code Style subsection within Packaging Guide section (#182)

* fix #193 change slack channel name to software-review from onboarding in editor checklist
add entry to news

* #128 taking over maint. chapter work, moved to new branch

* move taking over to chapter 10

* spelling changs in taking over chapter

* add news item for the taking over chapter #128

* Update JOSS instrucctions

* Explicitly use RO repo url in JOSS submittal.

* fix #180 add note for handling editors to nominate blog posts of interest

* fix some links in the changelog

* Fix #181 typo

* fix #191 add to approval template mention of including docs.ropensci.org link in DESCRIPTION file

* fix section link to docsropensci in pkg building chapter, was missing pound sign

* fix some broken urls in pkg_building

* fix spelling problems after using spelling
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content 📃
Projects
None yet
Milestone
0.3.0
Development

No branches or pull requests
2 participants
@cboettig @maelle