R paket dokumentasi item pesanan params

Saya memiliki paket fungsi; satu fungsi memiliki 22 parameter (termasuk ...). Saya baru-baru ini memindahkan parameter dari opsi ... menjadi parameter lengkap, dan memperhatikan bahwa meskipun itu dijelaskan dalam urutan logis dalam daftar parameter fungsi, dan dalam urutan yang sama dalam daftar item roxygen2 @params, ketika saya document() , item baru berada di bawah item ... di bagian bawah, dan diikuti oleh param lain yang saya dapatkan di tempat yang logis juga.

Contoh: Scriptnya seperti ini:

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

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

File rd & bantuan terlihat seperti ini:

Arguments

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

Saya tahu ini sepele, tetapi adakah yang tahu cara memperbaikinya? Saya menghapus file .Rd dan redocument()ed tetapi tidak berhasil.

Tangkapan layar album Imgur (3 foto) di sini: http://imgur.com/a/pUX4m

Edit: menggali lebih lanjut: Saya menjalankan build & reload, memeriksa, dan melihat:

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.

Paragraf terakhir sebelum "RC" di sini mengatakan @usage tidak diperlukan lagi sejak itu v3 dari roxygen2 menghasilkan ini secara otomatis. Tapi ini tidak berhasil lagi bagi saya, meskipun saya pernah berhasil di masa lalu.


person dez93_2000    schedule 27.09.2016    source sumber
comment
Apa sebenarnya rangkaian perintah yang Anda jalankan? Apakah ini semua terjadi di RStudio? Jika Anda dapat membuat masalah ini dengan mudah dapat direproduksi maka akan lebih mudah untuk membantumu   -  person MrFlick    schedule 27.09.2016
comment
hai, semua Rstudio, ya. Sebenarnya tidak mudah untuk direproduksi. Sejauh yang saya pahami, jika Anda memiliki item roxgyen2 dalam urutan tertentu, document() akan mendorongnya ke dokumen .Rd dalam urutan yang sama. Mungkin saja perubahan saya tidak ditulis. Tangkapan layar ditambahkan ke pertanyaan utama.   -  person dez93_2000    schedule 27.09.2016
comment
Tangkapan layar tidak terlalu membantu karena memotong bagian-bagian penting. Saya kira contoh dalam pertanyaan Anda tidak akurat. Menurut urutan parameter pembaruan kode ini harus sesuai urutan kemunculannya definisi fungsi formal, bukan urutan daftar atribut @param.   -  person MrFlick    schedule 27.09.2016
comment
Saya tidak yakin apa yang mereka potong itu berguna. Gambar 1 adalah bagian atas skrip R yang menunjukkan parameter roxygen2 dalam urutan yang benar. Gambar 2 di bawah pada skrip yang sama menunjukkan format definisi fungsi (saya pikir kita sedang membicarakan hal yang sama?) dalam urutan yang sama - benar. Gambar 3 adalah panel bantuan di Rstudio yang menampilkan html file Rd yang sesuai dengan skrip R, dihasilkan menggunakan document() saja.   -  person dez93_2000    schedule 27.09.2016
comment
Tampaknya, mengingat urutan argumen @params & fungsi saya di skrip R, document() harus mendorong ini ke file .Rd, dan komit/Push harus mendorong ini ke paket github, dan devtools::install_github(' SimonDedman/gbm.auto') harus mengunduh & menginstal paket yang diperbarui dengan urutan parameter yang benar di file bantuan & perubahan lain yang dilakukan. Saya khawatir pembaruan/push/unduhan tidak terjadi dengan benar karena perubahan lain pada skrip sepertinya tidak berfungsi. Saat saya mengetik gbm.auto untuk melihat skripnya, parameter tc & mapshape (yang muncul setelah ...) tidak ada.   -  person dez93_2000    schedule 27.09.2016


Jawaban (1)


Menemukan pelakunya: skrip lain ada di folder R dengan fungsi yang sama di dalamnya (pada dasarnya adalah konsep/garpu dari fungsi utama dengan sesuatu yang saya coba ubah). (Saya berasumsi bahwa) document() sedang menulis file Rd untuk gbm.auto dari gbm.auto.R lalu menimpa file Rd dari gbm.auto_binonly.R, menghapus semua perubahan. Maaf semuanya

person dez93_2000    schedule 27.09.2016