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

Added offline run flag and profile #29

Merged
merged 16 commits into from
May 23, 2024
Merged

Conversation

itrujnara
Copy link
Collaborator

Closes #28

  • added offline_run option
  • added offline profile

Note: the options only affect the ortholog fetching, downstream still requires network. FASTA input is not available for offline runs for now.

PR checklist

  • This comment contains a description of changes (with reason).
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).

Copy link

github-actions bot commented May 15, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 0b22de0

+| ✅ 217 tests passed       |+
!| ❗  11 tests had warnings |!

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-05-22 13:50:53

Copy link
Member

@JoseEspinosa JoseEspinosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some suggestions. Not sure if we should also check for any DBs that can not be run offline when the --offline parameter is set to also trough a warning


// Other parameters
offline_run = true
local_databases = true
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't you need also to provide here the paths to the local DBs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think I can. I have no prior knowledge of the file structure on the user's machine.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed on slack I was referring of creating a small version of the databases for running a test using the offline mode

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done now, see test_offline.config

ch_samplesheet_fasta.ifEmpty {
fasta_input = true
}
if (fasta_input && params.offline_run) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to through a warning here instead making clear that using fasta could have an impact on the rate limit if too many files are provided?

subworkflows/local/get_orthologs.nf Outdated Show resolved Hide resolved
Copy link
Member

@JoseEspinosa JoseEspinosa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM 🚀

@JoseEspinosa JoseEspinosa merged commit e68c8e9 into nf-core:dev May 23, 2024
8 checks passed
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

Successfully merging this pull request may close these issues.

Full offline run
2 participants