github
2.3.0
Kutipan : Haghish, EF (2020). Mengembangkan, memelihara, dan menghosting perangkat lunak statistik Stata di GitHub. Jurnal Stata, 20(4), 931-951.
github adalah modul Stata untuk mencari dan menginstal paket Stata dari GitHub, termasuk rilis paket sebelumnya. Ini adalah kombinasi dari beberapa perintah Stata seperti search , findit , dan ssc , namun dibuat untuk mengelola paket Stata yang dihosting di GitHub. Selain itu, paket ini menyediakan fitur-fitur baru untuk kontrol versi yang tidak tersedia bagi pengguna Stata di tempat lain (misalnya, paket ini memungkinkan instalasi paket Stata rilis lama untuk mereproduksi analisis yang dilakukan dengan perangkat lunak lama).
BERITA : Memperkenalkan perintah gitget . gitget semakin menyederhanakan instalasi dan pembaruan paket. ia menyediakan database untuk semua paket Stata yang ada di GitHub, yang memungkinkan Anda menginstal paket yang dihosting di GitHub - dan dikenal dengan gitget , cukup dengan mengetik:
gitget packagename
Perintah gitget bergantung pada daftar lengkap paket Stata di GitHub untuk mengidentifikasi URL suatu proyek. Daftar ini dibuat secara terprogram menggunakan program pencarian yang mendeteksi paket Stata. Pertama, semua repositori Stata diidentifikasi dan disimpan di repolist.dta . Selanjutnya, paket yang dapat diinstal diekstraksi dan disimpan di gitget.dta yang juga diinstal bersama paket tersebut di mesin Anda. Daftar lengkap arsip juga tersedia untuk pratinjau dalam repositori ini
Daftar isi
gitget Dalam beberapa tahun terakhir, pengguna Stata semakin banyak menggunakan GitHub untuk berbagi kode dan kumpulan data Stata, mengembangkan perangkat lunak statistik, dan menghosting paket Stata, seperti yang ditunjukkan pada gambar di bawah. Ini sungguh merupakan kabar baik bagi komunitas Stata dan siapa pun yang mempromosikan transparansi penelitian! Modul github , memfasilitasi pencarian, instalasi, pengelolaan, dan bahkan pembuatan paket Stata. Selain itu, ini memungkinkan instalasi versi pengembangan atau alternatifnya, rilis paket yang stabil. Hal ini juga memungkinkan menentukan dependensi paket yang akan diinstal secara otomatis, menjadikan GitHub lebih menarik bagi pengguna dan pengembang Stata. Di sini, saya segera menunjukkan cara menginstal dan menggunakan paket github .
github Anda dapat menginstal perintah github versi terbaru dengan menjalankan kode berikut:
net install github, from("https://haghish.github.io/github/")
Sintaks umum paket dapat diringkas sebagai:
github [subcommand] [...]
Dimana [ subperintah ] dapat berupa:
| Sub-perintah | Keterangan |
|---|---|
search | menemukan paket Stata di GitHub |
findfile | mencari file di antara semua paket Stata di GitHub |
install | menginstal paket dari GitHub |
list | memberikan informasi tentang paket yang diinstal dengan github |
query | mencantumkan semua rilis paket sebelumnya |
check | menguji apakah repositori dapat diinstal |
uninstall | menghapus paket dari Stata |
update | memperbarui paket dari GitHub |
version | mengembalikan versi paket yang diinstal |
dan [ ... ] dapat berupa nama pengguna/repositori atau nama paket berdasarkan subperintah yang ditentukan.
Untuk menginstal sebuah paket, yang Anda perlukan hanyalah nama pengguna GitHub dan nama repositori. Kombinasi nama pengguna dan nama repositori - dipisahkan dengan garis miring - memberikan URL yang diperlukan ke repositori. Misalnya untuk menginstal paket MarkDoc yang dihosting di https://github.com/haghish/markdoc cukup mengetik:
github install haghish/markdoc [, stable version("")]
Paket github menyertakan database untuk daftar lengkap paket Stata yang dihosting di GitHub. Oleh karena itu, Anda juga dapat menginstal sebuah paket hanya dengan menentukan nama paketnya. Perintah gitget - yang merupakan pembungkus untuk github install - dapat menginstal atau memperbarui paket Stata dari GitHub hanya dengan menanyakan nama paket:
gitget packagename [, stable version("")]
Misalnya, jika Anda ingin menginstal paket markdoc , mengetik gitget markdoc sama sulitnya dengan mengetik github install haghish/markdoc . Jika Anda ingin memeriksa daftar paket Stata yang dihosting di GitHub, lihat kumpulan data gitget.dta .
| Pilihan | Keterangan |
|---|---|
stable | menginstal versi rilis stabil terbaru dari paket tersebut |
version(str) | menginstal versi rilis yang ditentukan |
Anda dapat mencari paket Stata di GitHub menggunakan satu kata kunci atau banyak kata kunci. Ini mirip dengan perintah search atau findit Stata, namun hanya digunakan untuk mencari paket GitHub:
github search weaver
Mencari GitHub API secara efektif sangatlah penting. Untuk ini, paket ini menyertakan GUI pencarian yang menunjukkan sintaksis yang dapat Anda gunakan untuk mempersempit pencarian Anda atau memperluasnya untuk menyertakan sumber lain. Perintah pencarian juga menganalisis tanggal rilis untuk paket yang dihosting di perintah net , yang merupakan fitur yang sangat berguna. Untuk meluncurkan GUI, ketik:
db github
Misalnya, jika Anda menggunakan perintah github search untuk mencari paket markdoc , Anda mendapatkan keluaran berikut:
github memiliki database bawaan yang melacak paket-paket yang diinstal pada mesin Anda, dan tentu saja, juga memberi tahu Anda versi paket-paket yang diinstal pada mesin. Versi diambil dari tag rilis unik paket, yang ditentukan oleh pengembang. Anda dapat list paket yang diinstal dan mendapatkan informasi bermanfaat tentangnya. Perintah ini juga memberi tahu Anda jika ada pembaruan yang tersedia untuk paket GitHub Anda . Misalnya, pada keluaran di bawah, kita mengetahui bahwa ada pembaruan yang tersedia untuk dua paket kita. kita juga dapat mengklik link (update) untuk memperbarui paket ke rilis terbaru.
. github list
Tidak semua paket dapat diinstal. Repositori Stata harus memiliki file toc dan pkg agar dapat diinstal. Anda dapat memeriksa apakah suatu paket dapat diinstal atau tidak menggunakan subperintah check .
github check haghish/markdoc
Hal ini cukup penting untuk diperhatikan karena perintah
github searchyang digunakan untuk mencari paket Stata di GitHub, cenderung mengabaikan repositori Stata yang tidak dapat diinstal. Dengan kata lain, jika repositori Anda tidak menyertakan file-file ini, maka itu tidak akan dianggap sebagai paket Stata, kecuali Anda menentukan opsialldalam pencarian Anda (di GUI pencarian, centang opsi tampilkan repositori GitHub yang tidak dapat diinstal ). Namun, paketgithubjuga menyertakan GUI untuk membuat file-file ini. Dengan menggunakan GUI yang disertakan dengangithub, Anda dapat dengan mudah membuat file-file ini untuk repositori Anda (lihat di bawah).
Untuk menginstal sebuah paket, gunakan subperintah uninstall , diikuti dengan nama paket. Misalnya:
github uninstall markdoc
GitHub memungkinkan pengarsipan versi paket dalam jumlah tidak terbatas. Perintah github memiliki opsi untuk menentukan versi paket, memungkinkan instalasi versi paket sebelumnya. Misalnya, untuk menginstal paket MarkDoc versi lama, katakanlah 3.8.0 . Anda dapat mengetik:
github install haghish/markdoc , version("3.8.0")
Tetapi apakah Anda dapat melihat versi paketnya? GitHub memiliki tab rilis yang mencantumkan semua rilis perangkat lunak sebelumnya ( Lihat misalnya rilis MarkDoc sebelumnya ). Namun kabar baiknya adalah github memiliki subperintah untuk mencantumkan semua rilis sebelumnya di jendela hasil Stata dan memungkinkan Anda menginstal salah satu rilis tersebut ( serta dependensi paketnya untuk versi tertentu, jika ditentukan ) dengan satu klik mouse atau secara terprogram. Untuk melakukannya, ketik:
github query username/repository
Misalnya, untuk mencantumkan rilis MarkDoc sebelumnya, ketik:
. github query haghish/markdoc
----------------------------------------
Version Release Date Install
----------------------------------------
3.8.5 2016-10-16 Install
3.8.4 2016-10-13 Install
3.8.3 2016-10-03 Install
3.8.2 2016-10-01 Install
3.8.1 2016-09-29 Install
3.8.0 2016-09-24 Install
3.7.9 2016-09-20 Install
3.7.8 2016-09-19 Install
3.7.7 2016-09-18 Install
3.7.6 2016-09-13 Install
3.7.5 2016-09-08 Install
3.7.4 2016-09-07 Install
3.7.3 2016-09-06 Install
3.7.2 2016-09-05 Install
3.7.0 2016-08-23 Install
3.6.9 2016-08-16 Install
3.6.7 2016-02-27 Install
----------------------------------------
Saat menulis analisis dengan perangkat lunak dokumentasi dinamis, seperti MarkDoc , Anda harus melaporkan versi paket yang digunakan dalam analisis Anda. Anda dapat memperoleh versi paket yang terinstal secara terprogram menggunakan subperintah version , diikuti dengan:
. github version markdoc
3.8.0
Perintah ini tidak memiliki kegunaan lain karena perintah github list sudah menunjukkan versi paket yang diinstal dan juga memeriksa apakah ada versi terbaru yang tersedia...
Beberapa paket bergantung pada paket lain. Perintah github memungkinkan Anda menginstal dependensi paket dengan atau tanpa versi tertentu. Untuk melakukannya:
dependency.do dan sertakan dalam repositorigithub untuk menginstal dependensi paket dan bahkan tentukan versi yang diperlukan.github mencari dependency.do setelah menginstal paket dan jika menemukannya di repositori, ia akan mengeksekusinya. Misalnya, paket MarkDoc memiliki file dependency.do yang dapat menjadi contoh bagaimana file dependensi harus dibuat. Secara alami, file dependenc.do hanya dapat dieksekusi dengan perintah github install .
Paket github menyertakan database semua file yang diinstal dalam paket yang dihosting di GitHub. Ini adalah fitur penting bagi pengembang untuk menghindari pembuatan file dengan nama yang digunakan oleh pengembang lain karena paket tersebut tidak dapat diinstal bersama pada sistem yang sama (masalahnya juga ada pada nama program ). Paket github memungkinkan pengembang untuk memeriksa apakah nama tertentu telah digunakan dalam sebuah paket sebelumnya.
Subperintah findfile mencari githubfiles.dta (diinstal dengan paket) dan jika ditemukan, ia menunjukkan repositori yang menyertakan file tersebut. Misalnya mencari file yang memiliki kata kunci "dy" akan menghasilkan:
. github findfile dy
---------------------------------
Searching githubfiles database
---------------------------------
dynpandoc.ado
dynpandoc.sthlp
dynamicPage1.mata
---------------------------------
File-file ini juga menyertakan link ke repositorinya, jika Anda mengkliknya di jendela hasil.
Bayangkan Anda telah membuat file ado dan file bantuan Stata. Bagaimana Anda membuat repositori Anda dapat diinstal? Anda perlu membuat file stata.toc dan packagename.pkg secara manual, menentukan informasi yang diperlukan, file yang harus diinstal, dll. Paket github memperkenalkan make GUI yang menghasilkan instalasi paket untuk Anda, menggunakan tata letak yang ketat. Anda cukup memilih file yang ingin Anda instal, menentukan informasi yang diperlukan, dan menyiapkan file toc dan pkg Anda. Kemudian, segera setelah Anda menyalin file-file ini ke repositori Anda, file tersebut dapat diinstal!
Ubah direktori kerja ke jalur repositori lalu jalankan GUI, ketik:
db make
tuliskan informasi yang diperlukan dan pilih file yang harus diinstal. Tekan OK, dan nikmatilah!
gitget Kumpulan data gitget diunduh bersama dengan paket github . Kumpulan data ini diperbarui setiap bulan. Klik di sini untuk melihat daftar lengkap paket gitget .
EF Haghish
Pusat Biometri Medis dan Informatika Medis
Universitas Freiburg, Jerman
@Haghish
