R แพ็คเกจเอกสารประกอบรายการพารามิเตอร์ลำดับ

ฉันมีแพ็คเกจฟังก์ชั่น หนึ่งฟังก์ชันมี 22 พารามิเตอร์ (รวม ...) ฉันเพิ่งย้ายพารามิเตอร์จากการเป็นตัวเลือก ... ไปเป็นพารามิเตอร์แบบเต็ม และสังเกตเห็นว่าแม้ว่าจะมีการอธิบายตามลำดับตรรกะในรายการพารามิเตอร์ฟังก์ชัน และในลำดับเดียวกันในรายการรายการ roxygen2 @params เมื่อฉัน document() รายการใหม่อยู่ด้านล่างรายการ ... ที่ด้านล่างและตามด้วยพารามิเตอร์อื่นที่ฉันมีในตำแหน่งตรรกะด้วย

ตัวอย่าง: สคริปต์มีลักษณะดังนี้:

#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras

foo <- function(ParameterA, ParameterB, ...)

ไฟล์ Rd & help มีลักษณะดังนี้:

Arguments

Parameter A    does something
...            optional extras
Parameter B    does something else

ฉันรู้ว่านี่เป็นเรื่องเล็กน้อย แต่ไม่มีใครรู้วิธีแก้ไขปัญหานี้หรือไม่ ฉันลบไฟล์ .Rd และ redocument()ed ไม่มีประโยชน์

อัลบั้ม Imgur (3 รูป) ของภาพหน้าจอที่นี่: http://imgur.com/a/pUX4m

แก้ไข: ขุดเพิ่มเติม: ฉันรัน build & reload ตรวจสอบและเห็น:

Documented arguments not in \usage in documentation object 'gbm.auto':‘tc’ ‘mapshape’.
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.

ย่อหน้าสุดท้ายก่อน "RC" ที่นี่ บอกว่า @usage ไม่จำเป็นต้องใช้อีกต่อไปตั้งแต่นั้นมา v3 ของ roxygen2 จะสร้างสิ่งนี้โดยอัตโนมัติ แต่สิ่งนี้ไม่ได้ผลสำหรับฉันอีกต่อไปแล้ว แม้ว่าจะเคยทำงานมาก่อนก็ตาม


person dez93_2000    schedule 27.09.2016    source แหล่งที่มา
comment
ชุดคำสั่งที่คุณใช้งานอยู่คืออะไรกันแน่? ทั้งหมดนี้เกิดขึ้นใน RStudio หรือไม่? หากคุณสามารถทำให้ปัญหานี้ ทำซ้ำ ได้อย่างง่ายดาย ก็จะง่ายขึ้น ช่วยคุณ   -  person MrFlick    schedule 27.09.2016
comment
สวัสดี Rstudio ทุกคน ใช่แล้ว ไม่สามารถทำซ้ำได้ง่ายจริงๆ ตามที่ฉันเข้าใจ หากคุณมีรายการ roxgyen2 ของคุณในลำดับที่แน่นอน document() จะพุชรายการเหล่านั้นไปยังเอกสาร .Rd ในลำดับเดียวกัน อาจเป็นไปได้ว่าการเปลี่ยนแปลงของฉันไม่ได้ถูกเขียนขึ้นแต่อย่างใด เพิ่มภาพหน้าจอในคำถามหลัก   -  person dez93_2000    schedule 27.09.2016
comment
ภาพหน้าจอไม่มีประโยชน์มากนักเนื่องจากตัดส่วนสำคัญออกไป ฉันเดาว่าตัวอย่างในคำถามของคุณไม่ถูกต้อง ตาม การอัปเดตโค้ดนี้ ลำดับพารามิเตอร์ควรอยู่ในลำดับที่ปรากฏตามลำดับของ คำจำกัดความของฟังก์ชันอย่างเป็นทางการ ไม่ใช่ลำดับที่คุณแสดงรายการแอตทริบิวต์ @param   -  person MrFlick    schedule 27.09.2016
comment
ฉันไม่แน่ใจว่าสิ่งที่พวกเขาตัดออกนั้นมีประโยชน์ ภาพที่ 1 อยู่ด้านบนของสคริปต์ R ที่แสดงพารามิเตอร์ roxygen2 ตามลำดับที่ถูกต้อง รูปภาพที่ 2 ต่ำกว่าในสคริปต์เดียวกันที่แสดงรูปแบบคำจำกัดความของฟังก์ชัน (ฉันคิดว่าเรากำลังพูดถึงสิ่งเดียวกัน) ในลำดับเดียวกัน - ถูกต้อง ภาพที่ 3 เป็นบานหน้าต่างช่วยเหลือใน Rstudio ที่แสดง html ของไฟล์ Rd ที่สอดคล้องกับสคริปต์ R ซึ่งสร้างขึ้นโดยใช้ document() เท่านั้น   -  person dez93_2000    schedule 27.09.2016
comment
ดูเหมือนว่าเมื่อพิจารณาลำดับอาร์กิวเมนต์ @params & ฟังก์ชั่นของฉันในสคริปต์ R แล้ว document() ควรพุชสิ่งเหล่านี้ไปยังไฟล์ .Rd และคอมมิต/พุชควรพุชสิ่งเหล่านี้ไปยังแพ็คเกจ github และ devtools::install_github(' SimonDedman/gbm.auto') ควรดาวน์โหลดและติดตั้งแพ็คเกจที่อัปเดตพร้อมลำดับพารามิเตอร์ที่ถูกต้องในไฟล์วิธีใช้และการเปลี่ยนแปลงอื่น ๆ ที่ผลักดัน ฉันกังวลว่าการอัปเดต/พุช/ดาวน์โหลดไม่ได้เกิดขึ้นอย่างถูกต้อง เนื่องจากการเปลี่ยนแปลงอื่นๆ ในสคริปต์ดูเหมือนว่าอาจไม่ทำงาน เมื่อฉันพิมพ์ gbm.auto เพื่อดูสคริปต์ ไม่มีพารามิเตอร์ tc & mapshape (ซึ่งอยู่หลัง ...)   -  person dez93_2000    schedule 27.09.2016


คำตอบ (1)


พบผู้ร้าย: สคริปต์อื่นอยู่ในโฟลเดอร์ R ที่มีฟังก์ชันเดียวกันอยู่ภายใน (โดยพื้นฐานแล้วเป็นแบบร่าง/ทางแยกของฟังก์ชันหลักพร้อมกับสิ่งที่ฉันพยายามจะเปลี่ยน) (ฉันคิดว่า) document() กำลังเขียนไฟล์ Rd สำหรับ gbm.auto จาก gbm.auto.R จากนั้นเขียนทับไฟล์ Rd จาก gbm.auto_binonly.R โดยลบการเปลี่ยนแปลงทั้งหมด ขอโทษนะทุกคน

person dez93_2000    schedule 27.09.2016