Samtools로 너구리를 보여주세요!

↑ 너구리(너구리) at Obihiro Zoo ( Wikimedia )

　　　　__,-─-､__
　　　（〆-─-ヽ)
　　　 （ ´・ω・｀ ）  < Show a Tanuki with Samtools!
　　　/ 　,r‐‐‐､ヽ
　 　 し　ｌ　 x　）J
　　　_.'､ ヽ　 ノ.人
　(_((__,ノＵ´U. (酒)

소개

For those of you who came to this page hoping for a useful and serious bioinformatics article. I'm really sorry. If you opened this page expecting some useful information, please leave quietly. Nothing like that. Read only if you don't mind wasting time on silly content. I have warned you. (From Tanu Chronicle)

이번 포스팅에서는 Samtools에 tanuki 명령을 추가하여 ASCII art(AA) 타누키를 표시하도록 하겠습니다.

필요성 진술

원할 때마다 터미널에 너구리를 표시하는 것은 오랫동안 모든 인류의 꿈이었습니다. 저는 오늘 여기서 한 가지 해결책을 제시하고자 합니다.

tanuki의 ASCII 아트 찾기

터미널에 너구리를 표시하려면 너구리AA를 찾아야 합니다. 먼저 이 사이트에서 타누키 AA를 받으세요.

먼저 this page에서 tanuki ASCII 아트를 가져옵니다.

　　　　__,-─-､__
　　　（〆-─-ヽ)
　　　 （ ´・ω・｀ ）
　　　/ 　,r‐‐‐､ヽ
　 　 し　ｌ　 x　）J
　　　_.'､ ヽ　 ノ.人
　(_((__,ノＵ´U. (酒)

↑ 타누키



↑시가라키 도자기 너구리(너구리) ( Wikimedia )

샘툴 구축

먼저 Samtools가 성공적으로 구축될 수 있는지 확인합시다. 빌드에는 htslib 및 기타 종속성이 필요합니다. 제 경우에는 htslib 디렉토리를 samtools와 같은 디렉토리에 넣었습니다. 왜냐하면 제가 개인적인 관심을 위해 만든 htslib binding of Crystal language용으로 htslib를 직접 빌드했기 때문입니다. 여기에 htslib를 넣으면 samtools가 자동으로 감지할 수 있습니다. htslib에는 하위 모듈이 필요합니다git submodule update -i --recursive. 막히면 구글링 해주세요. 안정적인 태그git checkout 1.16.1를 확인하고 새 분기git switch tanuki로 전환하는 것이 더 안전합니다. 너하기에 달렸다.

그런 다음 GitHub의 README.md에 있는 지침에 따라 빌드하십시오.

autoheader            # Build config.h.in (this may generate a warning about
                      # AC_CONFIG_SUBDIRS - please ignore it).
autoconf -Wno-syntax  # Generate the configure script
./configure           # Needed for choosing optional functionality
make

주요 기능은 어디에 있습니까?

가장 먼저 알아낼 것은 samtools 명령을 입력할 때 호출되는 기본 함수가 어디에 있는지입니다.
VSCode에서 samtools 저장소를 열고 int main(를 검색하면 main 파일에서 bamtk.c를 찾을 수 있습니다.

이 파일 중간에 samtools help 를 입력하여 표시할 수 있는 도움말이 있습니다.

static void usage(FILE *fp)
{
    /* Please improve the grouping */

    fprintf(fp,
"\n"
"Program: samtools (Tools for alignments in the SAM format)\n"
"Version: %s (using htslib %s)\n\n", samtools_version(), hts_version());
    fprintf(fp,
"Usage:   samtools <command> [options]\n"
"\n"
"Commands:\n"
"  -- Indexing\n"
"     dict           create a sequence dictionary file\n"
"     faidx          index/extract FASTA\n"
"     fqidx          index/extract FASTQ\n"
"     index          index alignment\n"
"\n"
"  -- Editing\n"
"     calmd          recalculate MD/NM tags and '=' bases\n"
"     fixmate        fix mate information\n"
"     reheader       replace BAM header\n"
"     targetcut      cut fosmid regions (for fosmid pool only)\n"
"     addreplacerg   adds or replaces RG tags\n"
"     markdup        mark duplicates\n"
"     ampliconclip   clip oligos from the end of reads\n"
"\n"
"  -- File operations\n"
"     collate        shuffle and group alignments by name\n"
"     cat            concatenate BAMs\n"
"     consensus      produce a consensus Pileup/FASTA/FASTQ\n"
"     merge          merge sorted alignments\n"
"     mpileup        multi-way pileup\n"
"     sort           sort alignment file\n"
"     split          splits a file by read group\n"
"     quickcheck     quickly check if SAM/BAM/CRAM file appears intact\n"
"     fastq          converts a BAM to a FASTQ\n"
"     fasta          converts a BAM to a FASTA\n"
"     import         Converts FASTA or FASTQ files to SAM/BAM/CRAM\n"
"     reference      Generates a reference from aligned data\n"
"\n"
"  -- Statistics\n"
"     bedcov         read depth per BED region\n"
"     coverage       alignment depth and percent coverage\n"
"     depth          compute the depth\n"
"     flagstat       simple stats\n"
"     idxstats       BAM index stats\n"
"     phase          phase heterozygotes\n"
"     stats          generate stats (former bamcheck)\n"
"     ampliconstats  generate amplicon specific stats\n"
"\n"
"  -- Viewing\n"
"     flags          explain BAM flags\n"
"     head           header viewer\n"
"     tview          text alignment viewer\n"
"     view           SAM<->BAM<->CRAM conversion\n"
"     depad          convert padded BAM to unpadded BAM\n"
"     samples        list the samples in a set of SAM/BAM/CRAM files\n"
"\n"
"  -- Misc\n"
"     help [cmd]     display this help message or help for [cmd]\n"
"     version        detailed version information\n"
"\n");

거기에 tanuki 명령 도움말을 추가하십시오. 물론 tanuki는 매우 중요한 명령이므로 많은 사람들이 사용 방법을 알아보기 위해 도움말 파일을 참조할 수 있습니다. 도움이 중요합니다.

--- a/bamtk.c
+++ b/bamtk.c
@@ -203,6 +203,9 @@ static void usage(FILE *fp)
 "  -- Misc\n"
 "     help [cmd]     display this help message or help for [cmd]\n"
 "     version        detailed version information\n"
+"\n"
+"  -- Tanuki\n"
+"     tanuki         show a tanuki\n"
 "\n");
 }

그런 다음 더 아래로 스크롤하면 분명히 조건부 분기에 대한 코드가 있습니다.

    int ret = 0;
    if (strcmp(argv[1], "view") == 0)           ret = main_samview(argc-1, argv+1);
    else if (strcmp(argv[1], "import") == 0)    ret = main_import(argc-1, argv+1);
    else if (strcmp(argv[1], "mpileup") == 0)   ret = bam_mpileup(argc-1, argv+1);
    else if (strcmp(argv[1], "merge") == 0)     ret = bam_merge(argc-1, argv+1);
    else if (strcmp(argv[1], "sort") == 0)      ret = bam_sort(argc-1, argv+1);
    else if (strcmp(argv[1], "index") == 0)     ret = bam_index(argc-1, argv+1);
    else if (strcmp(argv[1], "idxstat") == 0 ||
             strcmp(argv[1], "idxstats") == 0)  ret = bam_idxstats(argc-1, argv+1);
    else if (strcmp(argv[1], "faidx") == 0)     ret = faidx_main(argc-1, argv+1);
    else if (strcmp(argv[1], "fqidx") == 0)     ret = fqidx_main(argc-1, argv+1);
    else if (strcmp(argv[1], "dict") == 0)      ret = dict_main(argc-1, argv+1);
    else if (strcmp(argv[1], "head") == 0)      ret = main_head(argc-1, argv+1);
    else if (strcmp(argv[1], "fixmate") == 0)   ret = bam_mating(argc-1, argv+1);
    else if (strcmp(argv[1], "rmdup") == 0)     ret = bam_rmdup(argc-1, argv+1);
    else if (strcmp(argv[1], "markdup") == 0)   ret = bam_markdup(argc-1, argv+1);
    else if (strcmp(argv[1], "ampliconclip") == 0) ret = amplicon_clip_main(argc-1, argv+1);
    else if (strcmp(argv[1], "flagstat") == 0 ||
             strcmp(argv[1], "flagstats") == 0) ret = bam_flagstat(argc-1, argv+1);
    else if (strcmp(argv[1], "calmd") == 0)     ret = bam_fillmd(argc-1, argv+1);
    else if (strcmp(argv[1], "fillmd") == 0)    ret = bam_fillmd(argc-1, argv+1);
    else if (strcmp(argv[1], "reheader") == 0)  ret = main_reheader(argc-1, argv+1);
    else if (strcmp(argv[1], "cat") == 0)       ret = main_cat(argc-1, argv+1);
    else if (strcmp(argv[1], "targetcut") == 0) ret = main_cut_target(argc-1, argv+1);
    else if (strcmp(argv[1], "phase") == 0)     ret = main_phase(argc-1, argv+1);
    else if (strcmp(argv[1], "depth") == 0)     ret = main_depth(argc-1, argv+1);
    else if (strcmp(argv[1], "coverage") == 0)  ret = main_coverage(argc-1, argv+1);
    else if (strcmp(argv[1], "bam2fq") == 0 ||
             strcmp(argv[1], "fastq") == 0 ||
             strcmp(argv[1], "fasta") == 0)     ret = main_bam2fq(argc-1, argv+1);
    else if (strcmp(argv[1], "pad2unpad") == 0) ret = main_pad2unpad(argc-1, argv+1);
    else if (strcmp(argv[1], "depad") == 0)     ret = main_pad2unpad(argc-1, argv+1);
    else if (strcmp(argv[1], "bedcov") == 0)    ret = main_bedcov(argc-1, argv+1);
    else if (strcmp(argv[1], "bamshuf") == 0)   ret = main_bamshuf(argc-1, argv+1);
    else if (strcmp(argv[1], "collate") == 0)   ret = main_bamshuf(argc-1, argv+1);
    else if (strcmp(argv[1], "stat") == 0 ||
             strcmp(argv[1], "stats") == 0)     ret = main_stats(argc-1, argv+1);
    else if (strcmp(argv[1], "flag") == 0 ||
             strcmp(argv[1], "flags") == 0)     ret = main_flags(argc-1, argv+1);
    else if (strcmp(argv[1], "split") == 0)     ret = main_split(argc-1, argv+1);
    else if (strcmp(argv[1], "quickcheck") == 0)  ret = main_quickcheck(argc-1, argv+1);
    else if (strcmp(argv[1], "addreplacerg") == 0) ret = main_addreplacerg(argc-1, argv+1);
    else if (strcmp(argv[1], "pileup") == 0) {
        fprintf(stderr, "[main] The `pileup' command has been removed. Please use `mpileup' instead.\n");
        return 1;
    }
    else if (strcmp(argv[1], "tview") == 0)   ret = bam_tview_main(argc-1, argv+1);
    else if (strcmp(argv[1], "ampliconstats") == 0)     ret = main_ampliconstats(argc-1, argv+1);
    else if (strcmp(argv[1], "samples") == 0)     ret = main_samples(argc-1, argv+1);
    else if (strcmp(argv[1], "consensus") == 0) ret = main_consensus(argc-1, argv+1);
    else if (strcmp(argv[1], "reference") == 0) ret = main_reference(argc-1, argv+1);
    else if (strcmp(argv[1], "version") == 0 || \
             strcmp(argv[1], "--version") == 0)
        long_version();
    else if (strcmp(argv[1], "--version-only") == 0) {
        printf("%s+htslib-%s\n", samtools_version(), hts_version());
    }
    else {
        fprintf(stderr, "[main] unrecognized command '%s'\n", argv[1]);
        return 1;
    }
    return ret;
}

여기에 main_tanuki를 추가하십시오. 이제 samtools tanuki가 main_tanuki()를 호출합니다.

--- a/bamtk.c
+++ b/bamtk.c
@@ -287,6 +290,7 @@ int main(int argc, char *argv[])
     else if (strcmp(argv[1], "samples") == 0)     ret = main_samples(argc-1, argv+1);
     else if (strcmp(argv[1], "consensus") == 0) ret = main_consensus(argc-1, argv+1);
     else if (strcmp(argv[1], "reference") == 0) ret = main_reference(argc-1, argv+1);
+    else if (strcmp(argv[1], "tanuki") == 0) ret = main_tanuki();
     else if (strcmp(argv[1], "version") == 0 || \
              strcmp(argv[1], "--version") == 0)
         long_version();

위로 스크롤하여 main_tanuki() 함수에 대한 프로토타입 선언을 추가합니다.

--- a/bamtk.c
+++ b/bamtk.c
@@ -72,6 +72,7 @@ int main_import(int argc, char *argv[]);
 int main_samples(int argc, char *argv[]);
 int main_consensus(int argc, char *argv[]);
 int main_reference(int argc, char *argv[]);
+int main_tanuki(void);

samtools는 그것 없이도 빌드할 수 있지만 없으면 컴파일 시 다음과 같은 경고 메시지가 나오므로 제대로 선언하는 것이 좋다.

bamtk.c: In function ‘main’:
bamtk.c:293:52: warning: implicit declaration of function ‘main_tanuki’ [-Wimplicit-function-declaration]
  293 |     else if (strcmp(argv[1], "tanuki") == 0) ret = main_tanuki(void);
      |                                                    ^~~~~~~~~~~

main_tanuki() 구현

tanuki 명령은 매우 중요하며 많은 사용자를 기대합니다. 그들 중 일부는 너구리를 공작이나 다른 것으로 바꾸려고 할 수도 있습니다. 이러한 미래에 대비하기 위해서는 헤더에 저작권 정보를 명확히 표시해야 합니다.
printf 로 너구리를 표시합니다.

/*  tanuki.c -- show you a tanuki.

    Copyright (C) 2022 Tanuki Institute.

    Author: kojix2

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.  */

#include <config.h>

#include <stdlib.h>
#include <stdio.h>

int main_tanuki(void)
{
    printf(
"　　　　__,-─-､__\n"
"　　　（〆-─-ヽ)\n"
"　　　 （ ´・ω・｀ ）\n"
"　　　/ 　,r‐‐‐､ヽ\n"
"　 　 し　ｌ　 x　）J\n"
"　　　_.'､ ヽ　 ノ.人\n"
"　(_((__,ノＵ´U. (酒)\n");

    return 0;
}

메이크파일 편집

마지막으로 Makefile을 편집합니다. AOBJS에 tanuki.o를 추가합니다. tanuki.o가 tanuki.c에 의존한다고 작성하십시오.

--- a/Makefile
+++ b/Makefile
@@ -44,7 +44,7 @@ AOBJS=      bam_aux.o bam_index.o bam_plcmd.o sam_view.o bam_fastq.o \
             bam_tview.o bam_tview_curses.o bam_tview_html.o bam_lpileup.o \
             bam_quickcheck.o bam_addrprg.o bam_markdup.o tmp_file.o \
             bam_ampliconclip.o amplicon_stats.o bam_import.o bam_samples.o \
-            bam_consensus.o consensus_pileup.o reference.o
+            bam_consensus.o consensus_pileup.o reference.o tanuki.o
 LZ4OBJS  =  $(LZ4DIR)/lz4.o

 prefix      = /usr/local
@@ -206,6 +206,7 @@ sam_opts.o: sam_opts.c config.h $(sam_opts_h)
 sam_utils.o: sam_utils.c config.h $(samtools_h)
 sam_view.o: sam_view.c config.h $(htslib_sam_h) $(htslib_faidx_h) $(htslib_khash_h) $(htslib_kstring_h) $(htslib_thread_pool_h) $(htslib_hts_expr_h) $(samtools_h) $(sam_opts_h) $(bam_h) $(bedidx_h)
 sample.o: sample.c config.h $(sample_h) $(htslib_khash_h)
+tanuki.o: tanuki.c
 stats_isize.o: stats_isize.c config.h $(stats_isize_h) $(htslib_khash_h)
 stats.o: stats.c config.h $(htslib_faidx_h) $(htslib_sam_h) $(htslib_hts_h) $(htslib_hts_defs_h) $(samtools_h) $(htslib_khash_h) $(htslib_kstring_h) $(stats_isize_h) $(sam_opts_h) $(bedidx_h)
 amplicon_stats.o: amplicon_stats.c config.h $(htslib_sam_h) $(htslib_khash_h) $(samtools_h) $(sam_opts_h) bam_ampliconclip.h

이것이 준비의 끝입니다.

짓다

위에서 작성한 빌드 명령을 실행하십시오.
그러나 이미 한 번 해본 적이 있다면 그냥 make를 사용하면 됩니다(아마도).

autoheader
autoconf -Wno-syntax
./configure
make

tanuki 명령을 실행합니다.

. /samtools tanuki .samtools tanuki 를 사용하지 않도록 주의하십시오. . /samtools tanuki 현재 디렉토리에서 samtools를 호출합니다.



너구리가 성공적으로 전시되었습니다.
드디어 Samtools와 함께 너구리가 나타났습니다!

그게 무슨 뜻이야?

나도 몰라. 인생에는 많은 신비가 있습니다. 왜 tanuki 명령입니까? 언젠가 밝히고 싶습니다.

결론

따라서 tanuki를 표시하는 명령이 samtools에 추가되었으며 이제 언제든지 tanuki를 표시할 수 있습니다.
해는 동쪽에서 뜨기 시작하여 서쪽으로 진다.
장기간의 안정과 평화가 지상에 임했습니다.

타누키의 푹신함이 당신과 함께하길!