millironx/XAM.jl
1
0
Fork 0
mirror of https://github.com/MillironX/XAM.jl.git synced 2024-11-14 22:33:14 +00:00
Code Issues Releases Packages Activity
XAM.jl/dev/index.html
zeptodoctor 85f1924b3d build based on 402bbef
2020-01-19 11:50:33 +00:00

2 lines
6.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · XAM.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">XAM.jl</span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a><ul class="internal"><li><a class="tocitem" href="#Description-1"><span>Description</span></a></li><li><a class="tocitem" href="#Installation-1"><span>Installation</span></a></li></ul></li><li><a class="tocitem" href="hts-files/">SAM and BAM</a></li><li><a class="tocitem" href="api/api/">API Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/BioJulia/XAM.jl/blob/develop/docs/src/index.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="XAM.jl-1"><a class="docs-heading-anchor" href="#XAM.jl-1">XAM.jl</a><a class="docs-heading-anchor-permalink" href="#XAM.jl-1" title="Permalink"></a></h1><p><a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public."/></a> <a href="https://github.com/BioJulia/XAM.jl/releases/latest"><img src="https://img.shields.io/github/release/BioJulia/XAM.jl.svg" alt="Latest Release"/></a> <a href="https://github.com/BioJulia/XAM.jl/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="MIT license"/></a> <a href="https://gitter.im/BioJulia/XAM.jl?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://badges.gitter.im/BioJulia/XAM.jl.svg" alt="Join the chat at https://gitter.im/BioJulia/XAM.jl"/></a></p><h2 id="Description-1"><a class="docs-heading-anchor" href="#Description-1">Description</a><a class="docs-heading-anchor-permalink" href="#Description-1" title="Permalink"></a></h2><p>XAM provides I/O and utilities for manipulating SAM and BAM formatted alignment map files.</p><h2 id="Installation-1"><a class="docs-heading-anchor" href="#Installation-1">Installation</a><a class="docs-heading-anchor-permalink" href="#Installation-1" title="Permalink"></a></h2><p>XAM is made available to install through BioJulia&#39;s package registry. Julia&#39;s package manager only uses the &quot;General&quot; package registry by default. Your Julia configuration needs to include the BioJulia registry to be able to install the latest version of XAM.</p><p>To add the BioJulia registry from the <a href="https://docs.julialang.org/en/v1/manual/getting-started/">Julia REPL</a>, press <code>]</code> to enter <a href="https://docs.julialang.org/en/v1/stdlib/Pkg/">pkg mode</a>, then enter the following command:</p><pre><code class="language-julia">registry add https://github.com/BioJulia/BioJuliaRegistry.git</code></pre><p>Once the registry is added, you can install XAM while in <a href="https://docs.julialang.org/en/v1/stdlib/Pkg/">pkg mode</a> with the following command:</p><pre><code class="language-julia">add XAM</code></pre><p>If you are interested in the cutting edge of the development, please check out the <a href="https://github.com/BioJulia/XAM.jl/tree/develop">develop branch</a> to try new features before release.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="hts-files/">SAM and BAM »</a></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> on <span class="colophon-date" title="Sunday 19 January 2020 11:50">Sunday 19 January 2020</span>. Using Julia version 1.3.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Reference in a new issue View git blame Copy permalink