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

README and docs/usage.md refer to FASTQC, not contamination screening of a genome assembly #45

Open
talioto opened this issue Mar 26, 2024 · 1 comment
Assignees
Labels
bug Something isn't working

Comments

@talioto
Copy link

talioto commented Mar 26, 2024

Description of the bug

From the documentation, it is unclear how to run the pipeline. Why give a samplesheet with read files when the point is to decontaminate an assembly?
These are the parameters:
input: './samplesheet.csv'
outdir: './results/'
genome: 'GRCh37'
How is the assembly given? GRCh37 doesn't seem to be a path. Why give the reads? What are done with them. I don't need a FASTQC report. Please fix the documentation.

Command used and terminal output

No response

Relevant files

No response

System information

No response

@talioto talioto added the bug Something isn't working label Mar 26, 2024
@DLBPointon DLBPointon self-assigned this Mar 26, 2024
@DLBPointon
Copy link
Contributor

Hi Tyler,
This pipeline is still in early development, so no none of the documentation matches the actual use case as of yet. This will change as the structure of the pipeline gets closer to completion. Currently, the CI/CD needs fixing, the data merging scripts need to be modularised and added along with busco BTK. Once these are complete we will have a complete pipeline structure which we can pre-release for public use.

The current yaml, for future reference, can be found in the most recent branch here:
https://github.com/sanger-tol/ascc/blob/kmer_count/assets/github_testing/test.yaml

This will be added too and changed at short notice as we move from a 1 pipeline run 1 assembly system to a 1 run 3 + n assemblies (primary, haplo, cobiont) system.

Reads will be used to calculate the coverage information across the genomic assembly and provide graphs comparing GC% and coverage.

The final pipeline will be entirely configurable, so outside of the minimal pipeline, you will be able to pick and choose the sub-workflows you need in particular.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants