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

What does dorado download --data <pod5_file> do? #1187

Open
Shians opened this issue Dec 19, 2024 · 3 comments
Open

What does dorado download --data <pod5_file> do? #1187

Shians opened this issue Dec 19, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation models Issues related to model selection

Comments

@Shians
Copy link

Shians commented Dec 19, 2024

Based on the help string

Usage: dorado [--help] [--model VAR] [--models-directory VAR] [--list] [--list-yaml] [--list-structured] [--data VAR] [--recursive] [--overwrite] [--verbose]...

Optional arguments:
  -h, --help          shows help message and exits
  --model             the model to download [nargs=0..1] [default: "all"]
  --models-directory  the directory to download the models into [nargs=0..1] [default: "."]
  --list              list the available models for download
  --list-yaml         list the available models for download, as yaml, to stdout
  --list-structured   list the available models in a structured format, as yaml, to stdout
  --data              path to POD5 data used to automatically select models [nargs=0..1] [default: ""]
  -r, --recursive     recursively scan through directories to load POD5 files
  --overwrite         overwrite existing models if they already exist
  -v, --verbose       [may be repeated]

I expected that using the --data argument would download only the models relevant to that particular pod5. However it appears to download all models. Is this the intended behavior?

@malton-ont
Copy link
Collaborator

Hi @Shians,

The --data argument is intended to be using in conjunction with specifying a model complex (e.g. hac,5mC_5hmC) via the --model parameter. See the docs here. We'll look into clarifying the inline documentation for this.

@malton-ont malton-ont added documentation Improvements or additions to documentation models Issues related to model selection labels Dec 19, 2024
@HalfPhoton
Copy link
Collaborator

@Shians, can you clarify what you mean by:

It appears to download all models. Is this the intended behavior?

If you specify --models hac --data reads - all hac models suitable for that condition are downloaded which is intended behaviour.

@Shians
Copy link
Author

Shians commented Dec 19, 2024

I had used the data argument without any other argument and it downloaded all models. Thanks for the clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation models Issues related to model selection
Projects
None yet
Development

No branches or pull requests

3 participants