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

minor request to update readme #25

Closed
devonorourke opened this issue Jan 30, 2020 · 1 comment
Closed

minor request to update readme #25

devonorourke opened this issue Jan 30, 2020 · 1 comment

Comments

@devonorourke
Copy link

Hi,
Thank you for maintaining this software. In my first attempt at running the program I received an error when trying to use a .vcf file. After searching through the issues posts I came across this thread which resolved my problem: if invoking the -T parameter to read from the GT field of the .vcf file, you also need to invoke the -c parameter.
Perhaps I'm mistaken with these parameters, but if this is in fact true, it would be helpful to make a minor update to the readme/documentation when using vcf files to remind users to use those flags (if needed). Maybe something like this?:

./ngsrelate  -h my.VCF.gz -O vcf.res
./ngsrelate  -h my.VCF.gz -O vcf.res -T GT -c    ## if specifying values from GT field in .vcf

Cheers,
Devon

@KHanghoj
Copy link
Collaborator

KHanghoj commented Feb 3, 2020

Thanks for the comment. I have added this to the readme.

@KHanghoj KHanghoj closed this as completed Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants