Skip to content

Commit

Permalink
Bump yacrd version to 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
natir committed Mar 1, 2022
1 parent fd179c2 commit 779aa58
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 17 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "yacrd"
version = "0.6.2"
version = "1.0.0"
authors = ["Pierre Marijon <[email protected]>"]
edition = '2021'

Expand Down
28 changes: 13 additions & 15 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,23 +20,21 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

/// Yacrd use overlap between reads, to detect 'good' and 'bad' region,
/// a region with coverage over the threshold is 'good' others are 'bad'.
/// If read has a 'bad' region in middle this reads is mark as 'Chimeric'.
/// If the ratio of 'bad' region length on total read length is larger than threshold this reads is marked as 'Not_covered'.

/// Yacrd can make some other actions:
/// - filter: for sequence or overlap file, record with reads marked as Chimeric or NotCovered isn't written in the output
/// - extract: for sequence or overlap file, record contains reads marked as Chimeric or NotCovered is written in the output
/// - split: for sequence file bad region in the middle of reads are removed, NotCovered read is removed
/// - scrubb: for sequence file all bad region are removed, NotCovered read is removed
#[derive(clap::Parser, Debug)]
#[clap(
version = "0.6.2 Ivysaur",
author = "Pierre Marijon <[email protected]>",
name = "yacrd",
override_help = "
Yacrd use overlap between reads, to detect 'good' and 'bad' region,
a region with coverage over the threshold is 'good' others are 'bad'.
If read has a 'bad' region in middle this reads is mark as 'Chimeric'.
If the ratio of 'bad' region length on total read length is larger than threshold this reads is marked as 'Not_covered'.
Yacrd can make some other actions:
- filter: for sequence or overlap file, record with reads marked as Chimeric or NotCovered isn't written in the output
- extract: for sequence or overlap file, record contains reads marked as Chimeric or NotCovered is written in the output
- split: for sequence file bad region in the middle of reads are removed, NotCovered read is removed
- scrubb: for sequence file all bad region are removed, NotCovered read is removed
"
version = "1.0.0 Magby",
author = "Pierre Marijon <[email protected]>",
name = "yacrd"
)]
pub struct Command {
/// path to input file overlap (.paf|.m4|.mhap) or yacrd report (.yacrd), format is autodetected and compression input is allowed (gz|bzip2|lzma)
Expand Down

0 comments on commit 779aa58

Please sign in to comment.