다른 패키지 내의 함수에서 @inheritParams를 사용할 수 있습니까?

Question

는 나는 내가 패키지하려는 모호한 TSV 형식 수입, 문서를 작성 : https://github.com/katrinleinweber/MWX-import/commits/package

수입업자 기능은 utils::read.table에 이름 skip_lines 매개 변수 그래서 난에 skip의 후자의 문서를 "통과"하고 싶은 전달 내 .Rd. 그러나 @inheritParams utils::read.table skip과 같은 몇 가지 표기법을 사용하면 항상 Warning: Failed to find topic […]이됩니다. 또 다른 패키지의 기능에서 하나의 특정 매개 변수를 상속 실제로 가능 여부

는 http://r-pkgs.had.co.nz/man.html 및 https://blog.rstudio.org/2017/02/01/roxygen2-6-0-0/을 읽은 후 나에게 분명하지 않다.

가능합니까? 그렇다면 모든 힌트를 주셔서 감사합니다!

Answer 1

@inheritParams utils::read.table을 사용하는 경우 utils::read.table의 매개 변수와 일치하는 매개 변수는 상속됩니다 (아직 명시 적으로 문서화되지 않은 경우). 따라서 skip_lines 대신 skip을 사용하면 사용 사례를 감안할 수 있습니다.

매개 변수 이름이 일치하지 않을 때 매개 변수에 대한 설명서를 상속하는 것이 가능하지 않다고 생각합니다.