2015-06-09 32 views
1

运行devtools :: document()的输出。我不知道如何解决这个问题,并且roxygen文档在帮助排除错误信息方面并不是很出色。任何想法如何摆脱这个,所以我的功能可以记录?Roxygen错误“跳过无效路径”

Updating NEONExclusionZones documentation 
Loading NEONExclusionZones 
First time using roxygen2 4.0. Upgrading automatically... 
Writing NAMESPACE 
Skipping invalid path: 1CalcMosqImpact-TITLE.Rd 
Skipping invalid path: 1IstotopicChange-TITLE.Rd 
Skipping invalid path: 1findInters-TITLE.Rd 
Skipping invalid path: 1rad_foot-TITLE.Rd 

这是我试图记录的函数的一个示例。我意识到它没有完整的文档,但我正在试图获得一个基本的包,我可以继续更新。

##'NAME 
#'@name 1findInters 
#' 
##'TITLE 
#'@title Find intersection between footprint curve and a threshold curve 
#' 
##'TYPE 
#'Standalone R Function 
#' 
##'DESCRIPTION 
#'@description Calculates where the flux footprint curve and the threshold curve intersect. 
#' 
##'USAGE 
#'\dontrun{ 
#' find_inters(fun_weight=impact_KM01[x,], location=x_step_airs[-1], threshold=SA_dist) 
#' } 
#' 
##'ARGUMENTS 
#' @param fun_weight List of footprint curve distances 
#' @param location List of distance from tower [m] 
#' @param threshold Threshold for influence of all activities on tower measurement source areas [%] 
#' 
##'DETAILS 
#' 
#' 
##'VALUE 
#' 
#' 
##'NOTE 
#' 
##'SEE ALSO 
#' 
#' 
#' 
#' 
##'EXAMPLES 
# 
#' 

find_inters <- function(
    fun_weight, 
    location, 
    threshold 
) { 

    #difference between footprint curve and threshold line 
    DIFF <- fun_weight - threshold 

    #interpolate to ensure finding local result 
    location1 <- approx(location, n=1e3)$y 
    DIFF1 <- approx(x=location, y=DIFF, xout=location1)$y  

    #find intersect farthest away from tower 
    #in order to find 1 real zero crossing, at least two zero crossings have to be present. 
    #Hence I added c(-1,1) here 
    WHR <- extrema(c(-Inf,Inf,DIFF1)) 
    if(WHR$ncross <= 1) { 
    out <- NA 
    } else { 
    #As I added c(-1,1) above, two indices have to be subtracted again here. 
    out <- round(location1[WHR$cross[WHR$ncross,2]-2]) 
    } 
    #return result 
    return(out) 

} 
+1

你应该遵循roxygen描述,小插曲,其他包等格式和例子https://github.com/yihui/roxygen2/ – rawr

回答

2

错误是因为你的文件名是用数字而不是字母。该relevant code is here that produces the message is here。我相信@ rawr的评论是正确的:您使用的是格式错误的Roxygen语法,这是造成问题的根本原因。

+0

修复它。我没有读过任何关于不能以数字开头的名字,但很高兴知道。谢谢! –