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

Treeval pipeline usage has a mistake #342

Open
Surbhigrewal opened this issue Nov 29, 2024 · 1 comment · Fixed by #344
Open

Treeval pipeline usage has a mistake #342

Surbhigrewal opened this issue Nov 29, 2024 · 1 comment · Fixed by #344
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@Surbhigrewal
Copy link

Surbhigrewal commented Nov 29, 2024

Description of the bug

In https://pipelines.tol.sanger.ac.uk/treeval/dev/usage

under Longread data preparation > FASTQ -> FASTA
there is a code

mkdir fasta
cd fastq
for i in *fq; do
echo $i
j=${i%.fq}
echo $j
seqtk seq -a $i > ../fasta/${j}.fasta
done

But in line 7 on the website there is "& gt;" which should be ">" (like here).

I had to put a space between & and gt here so that github doesn't automatically convert it to >.

And then just below that in FASTA -> FASTA.GZ
this line below

for i in .fasta; do

should be

cd fasta
for i in *.fasta; do

For those that don't have coding background (like me) this might take hours to figure out why the code is not working and debug.

Command used and terminal output

No response

Relevant files

No response

System information

No response

@Surbhigrewal Surbhigrewal added the bug Something isn't working label Nov 29, 2024
@DLBPointon
Copy link
Contributor

Hi @Surbhigrewal

Thanks for the issue.
This may be an issue with the pipeline's website itself in how it renders some symbols. As you can see here: https://github.com/sanger-tol/treeval/blob/main/docs/usage.md the > are as we would expect e.g. showing a >. I'll talk to the maintainer and see if we can correct that at all or at least add a note.

The rest are completely fair points. There are some errors; we are approaching a Version 1.2 release, so I will make sure we do a thorough check of the documents. A chunk of it needs rewriting anyway!

Thanks for getting in touch!

@DLBPointon DLBPointon self-assigned this Nov 29, 2024
@DLBPointon DLBPointon added the documentation Improvements or additions to documentation label Nov 29, 2024
@DLBPointon DLBPointon added this to the Release 1 milestone Nov 29, 2024
@DLBPointon DLBPointon linked a pull request Dec 10, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants