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.

Sign up for GitHub

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

Jump to bottom

config.md - mention string or map #5316

Closed
wants to merge 2 commits into from
Closed

config.md - mention string or map #5316

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6eab54f
config.md - mention string or map
ewels Sep 20, 2024
867ec85
Update config.md
ewels Sep 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1256,7 +1256,7 @@ The following settings are available:
: Project main script (default: `main.nf`).

`manifest.maintainer`
: Project maintainer(s) (String or map).
: Project maintainer(s). Can be a string of comma-separated values or a list of maps.
Copy link
Member

Choose a reason for hiding this comment

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

Nope, this is declared as a String

nextflow/modules/nextflow/src/main/groovy/nextflow/config/Manifest.groovy

Lines 62 to 64 in 62e2604

String getAuthor() {
target.author
}

We could use comma separate string for more than one author as for maintainer (map becomes a mess to handle on backend side)

Copy link
Member Author

Choose a reason for hiding this comment

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

Yup, this is following this comment: #5314 (comment) and originally #4034 (comment)

Essentially for both author and maintainer fields, I'd like to be able to optionally specify a number of fields:

  • Name
  • Email
  • Affiliation
  • ORCiD
  • GitHub

..for multiple authors / maintainers.

Having this info would allow us to roll it into other provenance outputs, like BCO and RO Crate. Which would in turn give rich authorship information in downstream platforms like WorkflowHub, Seqera Pipelines, the nf-core website and more. We could also build automation to fill it from GitHub contribution statistics in @nf-core and other nice stuff.

The string is simple, but not really useful. People put all kinds of things in there in different formats and so it's impossible to use for anything downstream.

Copy link
Member

Choose a reason for hiding this comment

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

This is an important deviation from what was implemented. Not sure any more all those should the manifest

Copy link
Member

Choose a reason for hiding this comment

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

It is true the author is declared as a string, so we can't re-use it. We'll have to add a new field like authors and maintainers, maybe deprecate the old ones

But we really do need more detailed fields for the author list so that it can be easily mapped to provenance manifests like BCO


`manifest.name`
: Project short name.
Expand Down
Loading