时间戳

首页 > 解决方案 > R CMD 检查未检测到我的文档

r - R CMD 检查未检测到我的文档

问题描述

当我跑

R CMD build mypackage
R CMD check mypackage_1.0.tar.gz

我收到这个警告：

Undocumented code objects:
  ‘func1’ ‘func2’

但是，我的包结构在man文件夹中记录了这些功能：

$ ls mypackage
DESCRIPTION  man  NAMESPACE  R  README.md  tests

这些功能特别有文档：

$ ll mypackage/man
-rw-r--r-- 1 user user  307 May 24 14:38 func1.Rd
-rw-r--r-- 1 user user  307 May 29 15:38 func2.Rd

看起来像这样：

$ cat mypackage/man/func1.R
\name{ func1 }
\title{ Do func1}
\description{
  This is well documented
  }

我想告诉 R 这是我的文档在哪里？

标签： r

解决方案

您忘记添加别名。

$ cat mypackage/man/func1.R
\name{ func1 }
\alias{ func1 }
\title{ Do func1}
\description{
  This is well documented
  }

这应该这样做。

推荐阅读