lbcb-sci / raven

De novo genome assembler for long uncorrected reads
MIT License
202 stars 21 forks source link

What is the raven.cereal file? #52

Open RachelDuffin opened 3 years ago

RachelDuffin commented 3 years ago

Hi,

I've looked through the documentation and I can't find an explanation of what the raven.cereal file is / what it does - would it be possible to explain?

Thanks!

rvaser commented 3 years ago

Hi Rachel, it is a binary file used to store checkpoints during the assembly for the case the user wants to resume a previous run (option --resume). If you do not want raven to generate it, you can use --disable-checkpoints options. The extension cereal was used to indicate the used library to store/load data to/from disk (https://github.com/USCiLab/cereal).

Best regards, Robert

RachelDuffin commented 3 years ago

Hi Robert,

I see - so can it be used to work out what stage the assembler is at? I'm not sure what the correct way would be to open & read the file.

Best wishes,

Rachel

rvaser commented 3 years ago

Hi Rachel, it is meant for internal use only, the log generated to stderr should indicate the stage the assembler is at.

Best regards, Robert