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

Create a help topic for the package #5

Closed
wleoncio opened this issue Aug 22, 2023 · 0 comments
Closed

Create a help topic for the package #5

wleoncio opened this issue Aug 22, 2023 · 0 comments
Assignees
@wleoncio
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@wleoncio
Copy link
Member

It's as easy as creating an R/{pkgname}-package.R file with the following content:

#' @keywords internal 
"_PACKAGE"

Even easier is to run usethis::use_package_doc(). This special "_PACKAGE" sentinel should create several entries automaticalli like package title, description, author list, useful URLs.

Source: https://r-pkgs.org/man.html#sec-man-package-doc
@wleoncio wleoncio added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 22, 2023
@wleoncio wleoncio self-assigned this Aug 31, 2023
wleoncio added a commit that referenced this issue Aug 31, 2023
@wleoncio
Added package documentation (#5)
cd8773e
wleoncio added a commit that referenced this issue Aug 31, 2023
@wleoncio
Resolved alias conflicts (#5)
aad2efd 
`permChacko-package` had a default alias `permChacko`, which is also the name of the package's main function
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wleoncio wleoncio

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wleoncio