Comments (3)
I brought this up via email: but, is Depends or Suggests, &c. more appropriate? Seems like we might need a mechanism for specifying this, unless e.g. Depends is implicit in @imports.
from roxygen.
Actually, it seems that entries in @imports
would must-often populate the Imports:
field of DESCRIPTION, since those are packages that have a namespace.
The Depends:
dependencies might need to be specified separately with an @Depends or equivalent. Part of the reason for this, IMHO, is that the Imports:/Depends: decision is contingent on whether that package has an appropriately-developed namespace, and also whether it is feasible/wise to have them "fully-loaded" in the global-environment. Since this is a tricky decision, and not necessarily based on the code within your own package, it seems the user will need to specify explicitly in some way.
@depends
is sortof in the style of the require(pkgname)
approach, and seems to fit with the rest of roxygen. I don't think this would interfere with the existing @imports
/ @importsFrom
/ etc. setup, which presumably would populate the Imports:
field in a similar way that they populate the NAMESPACE file.
I just noticed it is possible (if a package has a namespace) to have it listed as a Depends:
dependency in DESCRIPTION, but also imported with import(pkgname)
in the NAMESPACE. Is this a conflict or redundant? If so, I need to change it in that package, but also a good example in favor of adding this feature (and checks) to roxygen.
from roxygen.
I now think this is a bad idea - it's better to do the opposite and use information in DESCRIPTION to automatically populate NAMESPACE. These days you should very rarely being using depends.
from roxygen.
Related Issues (20)
- Checking for missing S3 method exports hangs "forever" if you have large data objects in the package HOT 2
- @include tag does not handle line breaks
- Support for inheriting S4 slots
- The definition of multiple @field field_1,field_2 in R6 object shows a warning.
- Adding "#' @inheritDotParams system" to roxygen comments causes devtools::document() to fail
- R-CMD Check Warning - Missing link or links in documentation object
- roxygenise() has side-effect of attaching the package HOT 1
- uninformative error message if comments within a function are #' rather than #
- `reexports.Rd` re-writes `lubridate` functions re-exported HOT 1
- If no public methods provided and cloneable is `FALSE`, roxygen2 will failed
- Always resolve to "anchored" Rd xrefs
- @export generates a wrong NAMESPACE directive for S3 methods of generics imported from a different package
- Allow for width/height setting when specifying an external image via markdown
- Unnecessary escaping of `%` inside multi-line character in R
- Improve indentation/wrapping for named vectors/lists in `\usage{}` blocks
- FR: add `is_md` to `parse_file()`
- The language is not respected when running inline code
- Homegrown `local_reproducible_output()` should set `cli.hyperlink = FALSE`
- `\usage()` length
- Markdown support for definition lists?
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from roxygen.