question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

--layout CLI param help confusing

See original GitHub issue

the help text for --layout is confusing - it should clearly state that not specifying a layout will make all embeddings in the dataset available, and that specifying layout names will restrict options to those specified.

Changes to be made:

  • CLI parameter --layout modified to accept N embedding names (rather than the current restriction of one). Any specified will present in the web UI. Default, if not specified, is to present all embeddings.
  • CLI parameter --layout changes to --embedding. Help and error text in the CLI change corresponding.
  • UI text changes from layout to embedding (eg, in the menu used to select an embedding)

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:1
  • Comments:17 (11 by maintainers)

github_iconTop GitHub Comments

1reaction
sidneymbellcommented, Aug 26, 2019

Is the difference in load time more than a few seconds? I think it’s worth a few seconds to have all the layouts available.

On Mon, Aug 26, 2019 at 2:34 PM Bruce Martin notifications@github.com wrote:

To clarify, --layout will reduce loading time, not rendering time. It just restricts the amount of data transferred from back-end to front-end at initialization time. For small or medium-sized datasets, the difference is probably immaterial…

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/chanzuckerberg/cellxgene/issues/824?email_source=notifications&email_token=ADAIYX6EBYPSJSCNOAQRLTTQGRD4RA5CNFSM4H3C2EZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5FYDVY#issuecomment-525042135, or mute the thread https://github.com/notifications/unsubscribe-auth/ADAIYX46O4IIBTUSSJUORTDQGRD4RANCNFSM4H3C2EZQ .

1reaction
sidneymbellcommented, Aug 22, 2019

I actually think this is outdated; now that we support any layout specified in adata.obsm['X_foo'], we could probably even just remove this argument. If we keep it, I’d be in favor of the changed functionality you propose where it specifies a default instead.

On Thu, Aug 22, 2019 at 10:38 AM Lia Prins notifications@github.com wrote:

@sidneymbell https://github.com/sidneymbell Do you have input or ideas for what would be better for the --layout option?

  • keep current functionality (specifying a layout via CLI means no other layouts are available in the UI) or
  • change functionality so that specifying a layout via CLI means that the specified layout is default when they open cellxgene, but they still have access to switching to any of the other available layouts through the UI’s “Layout choice” radio buttons

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/chanzuckerberg/cellxgene/issues/824?email_source=notifications&email_token=ADAIYXZZPTVODJLUTAPHPOLQF3FHRA5CNFSM4H3C2EZ2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD452YWQ#issuecomment-524004442, or mute the thread https://github.com/notifications/unsubscribe-auth/ADAIYX37BWB7ODQVNYOMHW3QF3FHRANCNFSM4H3C2EZQ .

Read more comments on GitHub >

github_iconTop Results From Across the Web

Is there a "standard" format for command line/shell help text?
@DanielPryden I think the answer in that question is a little misleading. It gives links that explain what switches should be accepted and...
Read more >
What are good habits for designing command line arguments?
Linux has tools for parsing such parameters and flags in an easy way ... Try to design your software from the command line...
Read more >
Command-line syntax overview for System.CommandLine
Most command-line apps support subcommands, also known as verbs. ... An option is a named parameter that can be passed to a command....
Read more >
Confusing / unclear -nameFromTemplate parameter #3 - GitHub
I am asked for the nameFromTemplate parameter in both cases. Azure CLI just works. @alex-frankel I send the template and params file via...
Read more >
Command Line Interface Guidelines
An open-source guide to help you write better command-line programs, taking traditional UNIX principles and updating them for the modern day.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found