A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://github.com/uptake/pkgnet/pull/193 below:

Write roxygen article for package · Issue #193 · uptake/pkgnet · GitHub

We don't currently have a package-level roxygen documentation article.

Conventionally, the way this would be done is by documenting a NULL object in pkgnet.R with the name pkgnet and setting @docType package. Then users would be able to land there with ?pkgnet.

UPDATE: It looks like the standard way to do this nowadays is to document a string object with the value "_PACKAGE". This is a special keyword for roxygen2 to know you're making a package documentation article, to create the right names, and to fill in some of the details (e.g., list of authors).

So the two things of note to do are:

References:


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4