简体   繁体   English

R package 描述未显示?

[英]R package DESCRIPTION not showing on?

Building an R package in RStudio roxygen2.在 RStudio roxygen2 中构建 R package。 Have these setting in Roxygen configure (below).在 Roxygen 中配置这些设置(如下)。 However, after I build, I'm unable to see the nice documentation when trying:但是,在我构建之后,我在尝试时无法看到漂亮的文档:

> ?PackageName

It just gives:它只是给出:

No documentation for ‘PackageName’ in specified packages and libraries:

you could try '??PackageName'你可以试试'??PackageName'

The DESCRIPTION file is just a standard description file.描述文件只是一个标准的描述文件。

在此处输入图像描述

You have to create in the /R directory of the package a specific file containing the description of the package as well as the following roxygen tags:您必须在 package 的 /R 目录中创建一个特定文件,其中包含 package 的描述以及以下 roxygen 标签:

#' @docType package
#' @name MyPackageName
NULL

NULL is necessary at the end, as no other object is defined here.最后需要 NULL,因为这里没有定义其他 object。

This file usually has the name of the package: MyPackageName.R该文件通常具有 package 的名称:MyPackageName.R

see http://r-pkgs.had.co.nz/man.html#man-packageshttp://r-pkgs.had.co.nz/man.html#man-packages

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM