search

nextstrain / augur

Pipeline components for real-time phylodynamic analysis
https://docs.nextstrain.org/projects/augur/
GNU Affero General Public License v3.0
268 stars 129 forks source link

How to have more control over the contents of the maintainers section? #515

Open terrycojones opened 4 years ago

terrycojones commented 4 years ago

On https://nextstrain.org/ncov the maintainers section at top reads Maintained by the Nextstrain team. Enabled by data from with a GISAID logo. I took a look in augur/export_v2.py and don't see how you're managing that. I'm assuming the name/URL dicts are ending up in JSON that is parsed by the auspice JS and (ordinarily) turned into the list of names with optional URLs. But not in the case of the ncov site! I took a look at https://github.com/nextstrain/ncov and don't see anything there.

If it's any motivation, I am trying to put "powered by" [nextstrain logo] (as well as the GISAID logo) into my maintainers line :-)

Thanks!

jameshadfield commented 4 years ago

The ncov site is using some custom auspice code. In general, we try to avoid situations like this unless there are compelling reasons, as they are not usable by others.

Ideally, there would be a way to specify this in the JSON, which would then be usable by any dataset, but this doesn't currently exist. Happy to keep this open to see if we can come up with such a field for the JSON.

terrycojones commented 4 years ago

Hi @jameshadfield - thanks for the quick reply. I'll have a look around and think. I've already put links on the top-level landing page, including to your 2018 paper. Hoping not to run afoul of GISAID, or anyone else :-)

No need to keep this open, unless you want to. In situations like this I normally provide a way for people who know what they're doing to supply the exact value, e.g., in this case by allowing the maintainers value to be a JSON object with an HTML key.

tsibley commented 4 years ago

One option is to introduce limited Markdown support in a new byline metadata property, which if it was present, would be used in preference to the existing byline construction that uses buildUrl, authors, etc. I say "limited Markdown" because Auspice would likely want to strip block-elements, headings, tables, etc from the resulting HTML.