3. KinMatch

KinMatch 는 커맨드라인 인터페이스로 제공되며 명령행에서 ./kinc -h 를 통해 도움말을 확인 할 수 있다.

$ ./kinc -h
usage: kinc [-h]
            {add-allele-frequencies,list-allele-frequencies,delete-allele-frequencies,show-allele-frequencies,make-current-allele-frequencies,add-genotypes,search,search-multiple,check-between,report-hml}
            ...

KinMatch commandline interface

optional arguments:
  -h, --help            show this help message and exit

subcommands:
  kinc has a few sub-commands

  {add-allele-frequencies,list-allele-frequencies,delete-allele-frequencies,show-allele-frequencies,make-current-allele-frequencies,add-genotypes,search,search-multiple,check-between,report-hml}
                        -h for additional help
    add-allele-frequencies
                        Add allele frequencies data to DB
    list-allele-frequencies
                        List all available allele frequencies
    delete-allele-frequencies
                        Delete allele frequencies by the name
    show-allele-frequencies
                        Show the allele frequencies table
    make-current-allele-frequencies
                        Make current allele frequencies by using current DB
    add-genotypes       Add many genotype data in batch file (generated by
                        GeneMark)
    search              Search relationship.
    search-multiple     Search relationship between groups.
    check-between       Check relationship between two queries.
    report-hml          Report checking result to HML format ('-a' option for
                        GroupA, '-b' for GroupB !!).

Copyright 2014, Insilicogen, Inc.

아래 표와 같이 ./kinc 는 총 10개의 프로그램으로 구성되어 있다. 각 프로그램별 도움말은 ./kinc [subcommand] -h 로 확인할 수 있다.

서브커맨드 기능
list-allele-frequencies List all available allele frequencies
add-allele-frequencies Add allele frequency data to DB
delete-allele-frequencies Delete allele frequencies by the name
show-allele-frequencies Show the allele frequencies table
make-current-allele-frequencies Make current allele frequencies by using current DB
add-genotypes Add many genotype data in batch file (generated by GeneMark)
search Search relationship
search-multiple Search relationship between groups
check-between Check relationship between two queries
report-html Report checking result to HML format

3.1. 유전자형 정보 관리 (genotype management)

3.1.1. add-genotypes

검사 및 검색에 사용되는 유전자형 정보(A-STR, Y-STR, SNP, mtDNA)를 추가하기 위해 add-genotype 을 사용한다. 옵션 목록은 다음과 같다.

$ ./kinc add-genotype [옵션...]
옵션 설명
-h, –help 도움말 보기
-i, –infile input 파일명 (여러개인경우 탭으로 구분)
-f, –format input 파일포맷 {GeneMark|JSON|CSV|XLSX}
-p, –type 유전자형정보 종류 {A-STR|Y-STR|SNP|mtDNA}
-c, –colums GeneMark 파일에서 ID, Marker, Allele1, Allele2에 해당하는 컬럼번호 (default: 0, 4, 6, 7)
-w, –overwrite 같은 identifier 덮어쓰기 허용
-t, –initial 데이터 초기화
-g, –group individuals의 그룹명

3.3. 대립유전자빈도 정보 관리 (allele frequency table management)

3.3.1. list-allele-frequencies

대립유전자 빈도 정보 목록을 출력하기 위해 list-allele-frequencies 를 사용한다.

$ ./kinc list-allele-frequencies [옵션...]
옵션 설명
-h, –help 도움말 보기
-s 대립유전자빈도 정보 출력시 컬럼 구분자 {tab|comma} (default: tab)

3.3.2. add-allele-frequencies

대립유전자 빈도정보를 추가하기 위해 add-allele-frequencies 를 사용한다.

$ ./kinc add-allele-frequencies [옵션...]
옵션 설명
-h, –help 도움말 보기
-n, –name 대립유전자빈도 데이터의 이름
-i, –infile Input 파일 이름 (.csv,.xls, or .xlsx)
-p, –type 대립유전자 유형 {A-STR|Y-STR|SNP}
-w, –overwrite 같은 이름의 대립유전자 정보 덮어쓰기 허용
-t, –initial 데이터 초기화

3.3.3. delete-allele-frequencies

대립유전자 빈도정보를 삭제하기 위해 delete-allele-frequencies 를 사용한다.

$ ./kinc delete-allele-frequencies [옵션...]
옵션 설명
-h, –help 도움말 보기
-n, –name 대립유전자빈도 데이터의 이름
-i, –infile Input 파일 이름 (.csv,.xls, or .xlsx)
-p, –type 대립유전자 유형 {A-STR|Y-STR|SNP}
-w, –overwrite 같은 이름의 대립유전자 정보 덮어쓰기 허용
-t, –initial 데이터 초기화

3.3.4. show-allele-frequencies

특정 대립유전자 빈도에 대한 상세정보를 보기 위해 show-allele-frequencies 를 사용한다.

$ ./kinc show-allele-frequencies -n NAME [옵션...]
옵션 설명
-h, –help 도움말 보기
-n, –name 대립유전자빈도 데이터의 이름 (필수)
-s, –seperator 각 행간의 구분 기호 (tab 혹은 comma)
-o, –outfile Output 파일 이름 (.csv,.xls, or .xlsx)
-e, –excelfile 엑셀파일 생성
-p, –type 대립유전자 유형 {A-STR|Y-STR|SNP}

3.4. 혈연관계 검사 (check-between)

3.4.1. check-between

두 유전자 간의 관계를 검사하기 위해 check-between 를 사용한다.

$ ./kinc check-between [옵션 ...]
옵션 설명
-h, –help 도움말 보기
-r, –relationship-type Relation type 설정 (identity, paternity, kinship)
-a, –quary-a 비교 검색 대상 식별번호 A
-b, –quary-b 비교 검색 대상 식별번호 B
-p, –type Genotype 유형 {A-STR|Y-STR|SNP|mtDNA}
-n, –name 대립 유전자 빈도 정보 데이터 설정
-s, –shared-allele 대립유전자 빈도정보 공유 ( type 이 paternity 일 때)

3.6. 다중비교검색 (search-multiple)

3.6.1. search-multiple

두 그룹간의 다:다 검색을 위해 search-multiple 를 사용한다.

$ ./kinc search-multiple [옵션 ...]
옵션 설명
-h, –help 도움말 보기
-r, –relationship-type Relation type 설정 (identity, paternity, kinship)
-ga, –group-a 검색 그룹 A 설정
-gb, –group-b 검색 그룹 B 설정
-n, –name 대립 유전자 빈도 정보 데이터 설정
-u’, `–partial 유전 정보 부분검색
-ma, –permit-mismatches-astr
A-STR Genotype 허용 불일치 수 설정
(Relation type 이 kinship 인 경우 사용 불가)
-pa, –permit-partial-astr A-STR Genotype에 대해 부분 검색 수행
-my, –permit-mismatches-ystr Y-STR Genotype 허용 불일치 수 설정
-py, –permit-partial-ystr Y-STR Genotype에 대해 부분 검색 수행
-mm, –permit-mismatches-mtdna mtDNA Genotype 허용 불일치 수 설정
-pm, –permit-partial-mtdna mtDNA Genotype에 대해 부분검색 수행
-em, –exclude-cstretch-mtdna C-Stretch 영역제외 여부

3.7. 검사보고서 (check-between-report)

3.7.1. report-hml

혈연 검색 (check-between) 결과를 HML 형식으로 출력하기 위해 report-hml 를 사용한다.

$ ./kinc report-hml [옵션 ...]
옵션 설명
-h, –help 도움말 보기
-a, –query-a 그룹 A에 대한 결과 파일 생성.(그룹은 관리자에 의해 변경 가능)
-b, –query-b 그룹 B에 대한 결과 파일 생성.(그룹은 관리자에 의해 변경 가능)
-o, –outfile 결과 파일명 설정