Mercurial > repos > iuc > obi_clean

changeset 5:816cbd8f4e6e draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/main/tools/obitools commit b017355279c18334e66ea8c0c0d7727fbd2876f7
author iuc
date Thu, 13 Nov 2025 10:25:22 +0000
parents 08d873cdd5f6
children
files obiclean.xml
diffstat 1 files changed, 25 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/obiclean.xml	Wed Mar 20 13:17:36 2024 +0000
+++ b/obiclean.xml	Thu Nov 13 10:25:22 2025 +0000
@@ -60,14 +60,34 @@
 
 **What it does**
 
-obijoinpairedend aims at joining the two reads of a paired-end library.
+obiclean is a command that classifies sequence records either as head, internal or singleton.
+
+For that purpose, two pieces of information are used:
+
+- sequence record counts
+- sequence similarities
 
-For this purpose, it concatenates sequence merging the forward read and the reversed-complemented reverse read.
+S1 a sequence record is considered as a variant of S2 another sequence record if and only if:
+
+- count of S1 divided by count of S2 is lesser than the ratio R. R default value is set to 1, and can be adjusted between 0 and 1 with the -r option.
+- both sequences are related to one another (they can align with some differences, the maximum number of differences can be specified by the -d option).
+
+Considering S a sequence record, the following properties hold for S tagged as:
 
-The program uses as input one or two sequences reads files.
+**head:**
+- there exists at least one sequence record in the dataset that is a variant of S
+- there exists no sequence record in the dataset such that S is a variant of this sequence record
+
+**internal:**
+- there exists at least one sequence record in the dataset such that S is a variant of this sequence record
 
-If two files are used one of them must be specified using the -r option. Sequence records corresponding to the same read pair must be in the same order in the two files.
-If just one file is provided, sequence records are supposed to be all of the same length. The first half of the sequence is used as forward read, the second half is used as the reverse read.
+**singleton:**
+- there exists no sequence record in the dataset that is a variant of S
+- there exists no sequence record in the dataset such that S is a variant of this sequence record
+
+By default, tagging is done once for the whole dataset, but it can also be done sample by sample by specifying the -s option. In such a case, the counts are extracted from the sample information.
+
+Finally, each sequence record is annotated with three new attributes head, internal and singleton. The attribute values are the numbers of samples in which the sequence record has been classified in this manner.
 
 @OBITOOLS_LINK@