ts-pkgx/dist/packages/htslib.org/samtools.d.ts

A library & CLI for managing packages

/**
 * **samtools** - Tools (written in C using htslib) for manipulating next-generation sequencing data
 *
 * @domain `htslib.org/samtools`
 * @programs `ace2sam`, `blast2sam.pl`, `bowtie2sam.pl`, `export2sam.pl`, `fasta-sanitize.pl`, ... (+17 more)
 * @version `1.22.0` (7 versions available)
 * @versions From newest version to oldest.
 *
 * @install `launchpad install +htslib.org/samtools -- $SHELL -i`
 * @dependencies `htslib.org`, `invisible-island.net/ncurses`, `zlib.net@1`
 *
 * @example
 * ```typescript
 * import { pantry } from 'ts-pkgx'
 *
 * const pkg = pantry.htsliborgsamtools
 * console.log(pkg.name)        // "samtools"
 * console.log(pkg.description) // "Tools (written in C using htslib) for manipulat..."
 * console.log(pkg.programs)    // ["ace2sam", "blast2sam.pl", ...]
 * console.log(pkg.versions[0]) // "1.22.0" (latest)
 * ```
 *
 * @see https://ts-pkgx.netlify.app/packages/htslib-org/samtools.md
 * @see https://ts-pkgx.netlify.app/usage
 */
export declare const htsliborgsamtoolsPackage: {
  /**
   * The display name of this package.
   */
  name: 'samtools';
  /**
   * The canonical domain name for this package.
   */
  domain: 'htslib.org/samtools';
  /**
   * Brief description of what this package does.
   */
  description: 'Tools (written in C using htslib) for manipulating next-generation sequencing data';
  packageYmlUrl: 'https://github.com/pkgxdev/pantry/tree/main/projects/htslib.org/samtools/package.yml';
  homepageUrl: '';
  githubUrl: 'https://github.com/pkgxdev/pantry/';
  /**
   * Command to install this package using launchpad.
   * @example launchpad install package-name
   */
  installCommand: 'launchpad install +htslib.org/samtools -- $SHELL -i';
  /**
   * Executable programs provided by this package.
   * These can be run after installation.
   */
  programs: readonly ['ace2sam', 'blast2sam.pl', 'bowtie2sam.pl', 'export2sam.pl', 'fasta-sanitize.pl', 'interpolate_sam.pl', 'maq2sam-long', 'maq2sam-short', 'md5fa', 'md5sum-lite', 'novo2sam.pl', 'plot-ampliconstats', 'plot-bamstats', 'psl2sam.pl', 'sam2vcf.pl', 'samtools', 'samtools.pl', 'seq_cache_populate.pl', 'soap2sam.pl', 'wgsim', 'wgsim_eval.pl', 'zoom2sam.pl'];
  companions: readonly [];
  /**
   * Required dependencies for this package.
   * These will be automatically installed.
   */
  dependencies: readonly ['htslib.org', 'invisible-island.net/ncurses', 'zlib.net@1'];
  /**
   * Available versions from newest to oldest.
   * @see https://ts-pkgx.netlify.app/usage for installation instructions
   */
  versions: readonly ['1.22.0', '1.21.0', '1.20.0', '1.19.2', '1.19.1', '1.19.0', '1.18.0'];
  aliases: readonly []
};
export type HtsliborgsamtoolsPackage = typeof htsliborgsamtoolsPackage