diff --git a/docs/tutorial.rst b/docs/tutorial.rst index 0387ae3..9f1542a 100644 --- a/docs/tutorial.rst +++ b/docs/tutorial.rst @@ -74,51 +74,30 @@ Summary of options: Input/output options: -+-------------------------------+---------------------------------------------------------------------------------+ -| -a/--alignment_file | alignment file in SAM/BAM/CRAM format | -+-------------------------------+---------------------------------------------------------------------------------+ -| -r/--reference_filename | path to a FASTA-formatted reference file for CRAM files. | -+-------------------------------+---------------------------------------------------------------------------------+ -| -f/--fasta | Fasta file containing raw reads | -+-------------------------------+---------------------------------------------------------------------------------+ -| -p/--pacbio | set this flag if input file contains PacBio reads instead of Illumina reads | -+-------------------------------+---------------------------------------------------------------------------------+ -| -n/--nanopore | set this flag if input file contains Nanopore MinION reads instead of Illumina | -+-------------------------------+---------------------------------------------------------------------------------+ -| -o/--outfile | file to write results. adVNTR writes output to stdout if oufile is not specified| -+-------------------------------+---------------------------------------------------------------------------------+ -| -of/--outfmt | output format. Allowed values are {text, bed} [text] | -+-------------------------------+---------------------------------------------------------------------------------+ +-f, --alignment_file alignment file in SAM/BAM/CRAM format +-r, --reference_filename path to a FASTA-formatted reference file for CRAM files. +-f, --fasta Fasta file containing raw reads +-p, --pacbio set this flag if input file contains PacBio reads instead of Illumina reads +-n, --nanopore set this flag if input file contains Nanopore MinION reads instead of Illumina +-o, --outfile file to write results. adVNTR writes output to stdout if oufile is not specified +-of, --outfmt output format. Allowed values are {text, bed} [text] Algorithm options: -+---------------------------+--------------------------------------------------------------------------------+ -| -fs/--frameshift | set this flag to search for frameshifts in VNTR instead of copy number. | -+---------------------------+--------------------------------------------------------------------------------+ -| -e/--expansion | set this flag to determine long expansion from PCR-free data | -+---------------------------+--------------------------------------------------------------------------------+ -| -c/--coverage | average sequencing coverage in PCR-free sequencing | -+---------------------------+--------------------------------------------------------------------------------+ -| --haploid | set this flag if the organism is haploid | -+---------------------------+--------------------------------------------------------------------------------+ -| -naive/--naive | use naive approach for PacBio reads | -+---------------------------+--------------------------------------------------------------------------------+ +-fs, --frameshift set this flag to search for frameshifts in VNTR instead of copy number. +-e, --expansion set this flag to determine long expansion from PCR-free data +-c, --coverage average sequencing coverage in PCR-free sequencing +--haploid set this flag if the organism is haploid +-naive, --naive use naive approach for PacBio reads Other options: -+---------------------------+--------------------------------------------------------------------------------+ -| -h/--help | show this help message and exit | -+---------------------------+--------------------------------------------------------------------------------+ -| --working_directory | working directory for creating temporary files needed for computation | -+---------------------------+--------------------------------------------------------------------------------+ -| -m/--models | file containing VNTRs information [vntr_data/hg19_VNTRs.db] | -+---------------------------+--------------------------------------------------------------------------------+ -| -t/--threads | number of threads [4] | -+---------------------------+--------------------------------------------------------------------------------+ -| -u/--update | set this flag to iteratively update the model | -+---------------------------+--------------------------------------------------------------------------------+ -| -vid/--vntr_id | comma-separated list of VNTR IDs | -+---------------------------+--------------------------------------------------------------------------------+ +-h, --help show this help message and exit +--working_directory working directory for creating temporary files needed for computation +-m, --models file containing VNTRs information [vntr_data/hg19_VNTRs.db] +-t, --threads number of threads [4] +-u, --update set this flag to iteratively update the model +-vid, --vntr_id comma-separated list of VNTR IDs View VNTRs @@ -134,27 +113,17 @@ The structure of VNTR and its genomic coordinate are required. Required arguments: -+-----------------------+----------------------------------------------------------------+ -| -r/--reference | Reference genome | -+-----------------------+----------------------------------------------------------------+ -| -c/--chromosome | Chromosome (e.g. chr1) | -+-----------------------+----------------------------------------------------------------+ -| -p/--pattern | First repeating pattern of VNTR in forward (5' to 3') direction| -+-----------------------+----------------------------------------------------------------+ -| -s/--start | Start coordinate of VNTR in forward (5' to 3') direction | -+-----------------------+----------------------------------------------------------------+ -| -e/--end | End coordinate of VNTR in forward (5' to 3') direction | -+-----------------------+----------------------------------------------------------------+ +-r, --reference Reference genome +-c, --chromosome Chromosome (e.g. chr1) +-p, --pattern First repeating pattern of VNTR in forward (5' to 3') direction +-s, --start Start coordinate of VNTR in forward (5' to 3') direction +-e, --end End coordinate of VNTR in forward (5' to 3') direction Other options: -+-------------------------+--------------------------------+ -| -g/--gene |Gene name | -+-------------------------+--------------------------------+ -| -a/--annotation |Annotation of VNTR region | -+-------------------------+--------------------------------+ -| -h/--help |show this help message and exit | -+-------------------------+--------------------------------+ +-g, --gene Gene name +-a, --annotation Annotation of VNTR region +-h, --help show this help message and exit You can use :code:`--update` in genotyping step to iteratively update the model using real data.