Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add files generated docs #19

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 96 additions & 0 deletions docs/files-generated.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
.. _files_generated:

===============
Files Generated
===============

Here, we provide a list of all files generated by MIPTools and a brief
description of each file. This list aims to assist users in determining the
most useful output for downstream analysis.

Non-aggregate Tables
====================

alternate_table
insert description

coverage_table
insert description

genotypes_table
insert description

reference_table
insert description

Aggregate Amino Acid Changes
============================

alternate_AA_table
insert description

coverage_AA_table
insert description

genotypes_AA_table
insert description

reference_AA_table
insert description

Aggregate Nucleotide Changes
============================

alternate_AN_table
insert description

coverage_AN_table
insert description

genotypes_AN_table
insert description

reference_AN_table
insert description

Haplotype Files
===============

aligned_haplotypes
insert description

all_haplotypes
insert description

haplotype_counts
insert description

mapped_haplotypes
insert description

offtarget_haplotypes
insert description

unique_haplotypes
insert description

Barcode Files
=============

all_barcode_counts
insert description

barcode_counts
insert description

Sequence Run Files
==================

repool
insert description

run_meta
insert description

sample_summary
insert description
6 changes: 6 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ inversion probe design, data processing, and analysis.
installation
quick_start

.. toctree::
:caption: Glossary
:maxdepth: 1

files-generated

Need Help?
----------

Expand Down