Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make a where_are_my_files.txt #42

Closed
ewels opened this issue Sep 11, 2018 · 3 comments
Closed

Make a where_are_my_files.txt #42

ewels opened this issue Sep 11, 2018 · 3 comments
Labels
enhancement New feature or request

Comments

@ewels
Copy link
Member

ewels commented Sep 11, 2018

In the rnaseq pipeline we save a text file called where_are_my_files.txt when the intermediate BAM files etc are not saved to results. Would be good to do that here too.

@ewels ewels added the enhancement New feature or request label Sep 11, 2018
@maxulysse
Copy link
Member

Not really sure I understand the point of that text file.
Can you elaborate a little more?

@ewels
Copy link
Member Author

ewels commented Sep 11, 2018

When intermediate files are not saved, we have empty directories with just logs and no Bam / FastQ files. Then users think that the pipeline hasn't worked and create bug reports. With this we just create a small file explaining this which gets copied into the results directory.

https://github.com/nf-core/rnaseq/blob/master/assets/where_are_my_files.txt
https://github.com/nf-core/rnaseq/blob/44f1525d7adfa3a6afcafdcf7730eca78a1a2511/main.nf#L489-L490

@maxulysse
Copy link
Member

Oh I see!
Good idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants