From 3068563a195739a6a81f77d033c3879ab1defcdc Mon Sep 17 00:00:00 2001 From: Kelsy Cotto Date: Tue, 10 Jan 2023 12:44:00 -0600 Subject: [PATCH] update docs for -b and -C options --- docs/commands/cis-splice-effects-identify.md | 6 ++++-- docs/commands/junctions-extract.md | 4 +++- docs/index.md | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/commands/cis-splice-effects-identify.md b/docs/commands/cis-splice-effects-identify.md index 56db2ef..0960992 100644 --- a/docs/commands/cis-splice-effects-identify.md +++ b/docs/commands/cis-splice-effects-identify.md @@ -1,9 +1,7 @@ [csei]: ../images/csei_examples.png - The `cis-splice-effects identify` command is used to identify splicing misregulation events. This command takes in a list of variants in the VCF format and RNAseq alignments produced with a splice-aware aligner in the BAM format. The tool then proceeds to identify non-canonical splicing junctions near the variant sites. - ## Usage `regtools cis-splice-effects identify [options] variants.vcf alignments.bam ref.fa annotations.gtf` @@ -33,6 +31,10 @@ The `cis-splice-effects identify` command is used to identify splicing misregula | -I | Annotate variants in intronic space within a transcript(not to be used with -i). | | -E | Annotate variants in exonic space within a transcript(not to be used with -e). | | -S | Don't skip single exon transcripts. | +| -b | The file containing the barcodes of interest for single cell data. | +| -C | Tells cis-splice-effects identify that you want intron-motif method to take priority when assigning strand. i.e. decide strandedness based on the fasta rather than what is encoded in the alignment file. | + +**Note** Both junctions extract and cis-splice-effects identify have an intron-motif method that can be used to determine strandedness of junctions extracted from alignment files. Using this method supercedes any strandedness information that might be encoded in the alignment file. To use this method with cis-splice-effects identify, you can the -C option to tell RegTools that you want the intron-motif method to take priority when assigning strandedness. ## Output diff --git a/docs/commands/junctions-extract.md b/docs/commands/junctions-extract.md index 56e7cf8..4eeb7ca 100644 --- a/docs/commands/junctions-extract.md +++ b/docs/commands/junctions-extract.md @@ -2,7 +2,6 @@ The `junctions extract` command can be used to extract exon-exon junctions from an RNAseq BAM file. The output is a BED file in the BED12 format. We have tested this command with alignments from HISAT2, TopHat2, STAR, kallisto, and minimap2 and by comparing the exon-exon junctions with the `junctions.bed` file produced from TopHat. - ## Usage `regtools junctions extract [options] indexed_alignments.bam` @@ -24,6 +23,9 @@ The `junctions extract` command can be used to extract exon-exon junctions from | -r | Region to extract junctions in. This is specified in the format "chr:start-end". If not specified, junctions are extracted from the entire BAM file.| | -h | Display help message for this command.| | -s | Strand specificity of RNA library preparation, where the options XS, use XS tags provided by aligner; RF, first-strand; FR, second-strand. This option is required. If your alignments contain XS tags, these will be used in the "unstranded" mode. If you are unsure, we have created this [table](https://rnabio.org/module-09-appendix/0009/12/01/StrandSettings/) to help. +| -b | The file containing the barcodes of interest for single cell data. | + +**Note** Both junctions extract and cis-splice-effects identify have an intron-motif method that can be used to determine strandedness of junctions extracted from alignment files. Using this method supercedes any strandedness information that might be encoded in the alignment file. To use this method with junctions extract, you can add a fasta file at the end of your junctions extract command which will tell RegTools that you want the intron-motif method to take priority when assigning strandedness. e.g. `regtools junctions extract [options] indexed_alignments.bam fasta.fa` ## Output diff --git a/docs/index.md b/docs/index.md index 3afd36e..25d8ef4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -27,7 +27,7 @@ make regtools --help ``` -If one wishes to test their installation, we include test data under `test_data`. +If one wishes to test their installation, we include test data under `test_data`. Here's an example command using that data along with the example output.