indo-r / rstadata Goto Github PK

Saya menemukan package serupa, untuk tarik data BPS lewat WebAPI v1: https://github.com/dzulfiqarfr/bpsr

Silakan rekan-rekan kontributor dapat berbagi referensi terkait pengambangan wrapper untuk WebAPI v1 BPS dengan berdiskusi dan mengikuti issue ini.
Terima kasih.

Dokumentasi resmi WebAPI BPS: https://webapi.bps.go.id/documentation/

Untuk "ngumpulin tugas" apakah perlu kita bikin branch khusus (misalnya devel, colab, dll.) di repository utama? Supaya kalau pull request tidak langsung ke branch main. Mohon masukkan untuk alur kerja yang sesuai dan aman.

Berdasarkan gaya penulisan nama fungsi yang dipakai oleh package-package modern (terutama gaya tidyverse), saya ingin mengusulkan untuk menamai fungsi-fungsi utama (fitur) dari package rstadata ini dengan prefix bps_ ketika berinteraksi dengan API BPS, seperti halnya:

• str_* pada stringr untuk manipulasi data tipe string
• geom_* pada ggplot2 untuk berinteraksi dengan bentuk atau jenis plot
• st_* pada sf untuk berinteraksi dengan metode manipulasi data spasial
• dan lain-lain.

Maksudnya tentu untuk memudahkan pengguna dalam mengingat dan mengakses fungsi melalui fitur autocompletion pada IDE masing-masing hanya melalui ketikan.

Jika mereplikasi fitur dari modul Python stadata, terdapat kategori/kelompok fitur:

• list: untuk memperoleh daftar parameter yang diperlukan untuk mengakses data
• view: untuk berinteraksi dengan atau memperoleh data yang diinginkan

dengan objeknya:

• domain (hanya untuk kategori list)
• static table
• dynamic table
• press release
• publication

Sehingga, penamaannya boleh jadi menjadi seperti:

• keluarga bps_get_* untuk mereplikasi fitur daftar (list), contoh: bps_get_domain(), bps_get_table(), bps_get_publication(), dsb. (hanya contoh)
• keluarga bps_view_* untuk mereplikasi fitur penarikan Data of Interest (view), contoh: bps_view_publication(), dsb.

Adapun fitur API yang lebih lengkap dan kompleks perlu dipetakan/diekstraksi dari dokumentasi resmi BPS.

Pertanyaan lain adalah: apakah penamaan argumen (parameter fungsi) lebih baik diseragamkan dengan library versi Python, atau dibuat dengan kaidah sendiri? Ini mungkin akan berguna untuk pengguna yang biasa berpindah antara R dan Python, tapi pastinya bukan keharusan karena untuk penyeragaman bisa jadi akan menemui kesulitan tersendiri.

Edit: saya menemukan bahwa penamaan argumen/parameter fungsi dan metode yang dipakai library Python stadata mengikuti yang sudah ada di dokumentasi BPS. Jadi mungkin ini bisa dipakai.

Saya tidak tahu apakah cara penamaan ini tepat atau tidak, tapi mungkin bisa jadi pemantik awal untuk dapat kesepakatan cara penamaan yang lebih baik. Mohon komentar, masukkan, dan koreksi dari rekan-rekan sekalian.

Terima kasih.