Skip to contents

KOSIS 통계 정보 설명

desc_kosis_stats.Rd

desc_kosis_stats() 함수는 KOSIS API의 지정된 메타데이터 정보를 검색합니다.

Usage

desc_kosis_stats(
  tbl_id = NULL,
  org_id = NULL,
  type = c("TBL", "ORG", "PRD", "ITM", "CMMT", "UNIT", "SOURCE", "NCD"),
  api_key = Sys.getenv("KOSIS_API_KEY"),
  verbose = FALSE
)

Arguments

tbl_id

character. 데이터 ID.

org_id

character. 제공기관 ID. 기본값은 NULL.

type

character. 메타 정보 선택. "TBL", "ORG", "PRD", "ITM", "CMMT", "UNIT", "SOURCE", "NCD"에서 선택. 각 유형의 설명은 다음과 같습니다.

  • "TBL" : 데이터 명칭

  • "ORG" : 기관 명칭

  • "PRD" : 집계 주기/기간

  • "ITM" : 개별 데이터 항목

  • "CMMT" : 주석 정보

  • "UNIT" : 단위 정보

  • "SOURCE" : 데이터 출처

  • "NCD" : 데이터 갱신일

api_key

character. KOSIS API 키. 기본값은 환경 변수 "KOSIS_API_KEY"에서 가져옵니다.

verbose

logical. TRUE로 설정하면 API URL을 출력합니다. 기본값은 FALSE입니다.

Value

data.frame 객체로 KOSIS 통계 메타데이터 정보. 만약 API 호출 시 에러가 발생하면, 에러 메시지를 포함한 list 객체. KOSIS 통계 메타데이터 정보로 반환하는 data.frame 객체는 type 인수에 따라 그 내용이 다릅니다.

  • "TBL" : 데이터 명칭

    • TBL_NM : 데이터 명칭

  • "ORG" : 기관 명칭

    • ORG_NM : 기관 명칭

    • ORG_NM_ENG : 기관 영문 명칭

  • "PRD" : 집계 주기/기간

    • PRD_SE : 집계 주기

    • STRT_PRD_DE : 집계 시작 기간

    • END_PRD_DE : 집계 종료 기간

  • "ITM" : 개별 데이터 항목

    • ORG_ID : 기관 코드

    • OBJ_ID : 객체 ID

    • OBJ_NM : 객체 명칭

    • OBJ_ID_SN : 객체 ID 일련번호

    • OBJ_NM_ENG : 객체 영문 명칭

    • UP_ITM_ID : 상위 데이터 항목 ID

    • ITM_NM : 데이터 항목 명칭

    • ITM_ID : 데이터 항목 ID

    • ITM_NM_ENG : 데이터 항목 영문 명칭

    • UNIT_ID : 단위 ID

    • UNIT_NM : 단위 명칭

    • UNIT_ENG_NM : 단위 영문 명칭

  • "CMMT" : 주석 정보

    • CMMT_NM : 주석 이름

    • CMMT_DC : 주석

    • OBJ_NM : 객체 명칭

    • OBJ_ID : 객체 ID

  • "UNIT" : 단위 정보

  • "SOURCE" : 데이터 출처

    • STAT_ID : 통계 ID

    • JOSA_NM : 출처 명칭

    • DEPT_PHONE : 출처 전화번호

    • DEPT_NM : 제공 부서

  • "NCD" : 데이터 갱신일

    • ORG_NM : 기관 명칭

    • TBL_NM : 데이터 명칭

    • PRD_SE : 집계 주기

    • PRD_DE : 집계 기준 기간

    • SEND_DE : 데이터 갱신일

#' 만약 API 호출 시 에러가 발생하면, 다음과 같은 에러 정보를 포함한 list 객체.

  • "err" : 에러 코드

  • "errMsg" : 에러 메시지

Details

이 함수는 제공된 데이터 ID와 기관코드(organization ID)를 기반으로 KOSIS API에서 메타데이터 정보를 검색합니다.

Examples

# \donttest{
# Generate data for the example
tbl_id <- "DT_1YL20631"
org_id <- "101"

desc_kosis_stats(tbl_id = tbl_id, org_id = org_id, type = "ITM")
#> Error in desc_kosis_stats(tbl_id = tbl_id, org_id = org_id, type = "ITM"): API key is missing. Please provide a valid KOSIS API key.
# }