Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Juke34 committed Jul 9, 2024
1 parent 38ca498 commit daa5443
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 10 deletions.
8 changes: 4 additions & 4 deletions bin/agat_sp_filter_feature_by_attribute_value.pl
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ =head1 DESCRIPTION
/!\ Removing a level1 or level2 feature will automatically remove all linked subfeatures.
/!\ Removing all children of a feature will automatically remove this feature too (excepted if --keep_parental is activated).
/!\ If --keep_parental is not activated and --na_aside is activated, and all level3 features of a record are split between both <output>_na.gff and <output>_discarded.gff,
, then the parental level1 and level2 features are removed and will end up in the <output>_na.gff file only.
then the parental level1 and level2 features are removed and will end up in the <output>_na.gff file only.
=head1 SYNOPSIS
Expand Down Expand Up @@ -426,22 +426,22 @@ =head1 OPTIONS
=item B<--na_aside>
Bolean. Deactivated by default. By default if the attribute tag on which the filter is based is missing, the feature will be written into <output>.
When activated, such features will be written into a separate file called <output>_na.gff
When activated, such features will be written into a separate file called <output>_na.gff.
=item B<--keep_parental>
Bolean. Deactivated by default. When activated even if all child features have been removed, the parental one will be kept.
=item B<-t> or B<--test>
Test to apply (> < = ! >= <=). default value "=".
If you use one of these two character >, <, please don't forget to quote the
parameter like that "<=" otherwise your terminal will complain.
Only = and ! tests can be used to compare string values.
=item B<-o> or B<--output>
Output GFF file. If no output file is specified, the output will be
Output GFF file. If no output file is specified, the output will be
written to STDOUT.
=item B<-v>
Expand Down
23 changes: 17 additions & 6 deletions docs/tools/agat_sp_filter_feature_by_attribute_value.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,14 @@
## DESCRIPTION

The script aims to filter features according to attribute value (9th column).
If the attribute tag is missing the feature will not be discarded.
If the attribute exists and the value pass the test, the feature is discarded.
Attribute are stored in the 9th column and have this shape: tag=value
/!\\ Removing a level1 or level2 feature will automatically remove all linked subfeatures, and
removing all children of a feature will automatically remove this feature too.
- If the attribute exists and the value do not pass the test, the feature is written into <output>.
- If the attribute exists and the value pass the test, the feature is discarded and written into <output>_discarded.gff.
- If the attribute tag is missing (test cannot be applyed), the feature will be written into <output> by default. If --na_aside parameter is activated then it will be written into <output>_na.gff.

Attribute are stored in the 9th column and have this shape: tag=value.
/!\\ Removing a level1 or level2 feature will automatically remove all linked subfeatures.
/!\\ Removing all children of a feature will automatically remove this feature too (excepted if --keep_parental is activated).
/!\\ If --keep_parental is not activated and --na_aside is activated, and all level3 features of a record are split between both <output>_na.gff and <output>_discarded.gff, then the parental level1 and level2 features are removed and will end up in the <output>_na.gff file only.

## SYNOPSIS

Expand Down Expand Up @@ -43,6 +46,14 @@ agat_sp_filter_feature_by_attribute_value.pl --help

Bolean. Deactivated by default. When activated the values provided by the --value parameter are handled case insensitive.

- **<--na\_aside**

Bolean. Deactivated by default. By default if the attribute tag on which the filter is based is missing, the feature will be written into <output>.
When activated, such features will be written into a separate file called <output>_na.gff.

- **<--keep\_parental>**

Bolean. Deactivated by default. When activated even if all child features have been removed, the parental one will be kept.

- **-t** or **--test**

Expand All @@ -53,7 +64,7 @@ agat_sp_filter_feature_by_attribute_value.pl --help

- **-o** or **--output**

Output GFF file. If no output file is specified, the output will be
Output GFF file. If no output file is specified, the output will be
written to STDOUT.

- **-v**
Expand Down

0 comments on commit daa5443

Please sign in to comment.