Add printing to remaining classes #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Different output format to match Python
Match Python output
Adjust Registry printing
These would cause issues if the docs are ever rendered. Content was moved to @description.
ExamplesArtifact
Python
R
Field
Python
R
Instance
R
R (
|
rcannood
reviewed
Oct 11, 2024
| .api: API, R6 | ||
| .module_classes: list | ||
| .settings: InstanceSettings, R6 | ||
| cellxgene Instance(modules='c('core', 'bionty')') |
There was a problem hiding this comment.
This should probably say something like cellxgene Instance(modules=c('core', 'bionty')).
Given that there is currently no documentation on what you can or cannot do with an Instance class, could we shed some light on:
- The instance core classes
- An instance's extra modules (e.g. bionty, wetlab)
- A list of functions uses can call
There was a problem hiding this comment.
Or maybe this is something that should be part of something like instance$describe()? Shall I make a separate issue for this?
There was a problem hiding this comment.
I've changed it to the longer format I was using for Module and Registry. I think that should show enough info now. The examples above are updated.
rcannood
reviewed
Oct 11, 2024
lazappi
added a commit
that referenced
this pull request
Oct 14, 2024
* origin/main: Add printing to remaining classes (#31) Improve error messages (#30) Update documentation (#29) Return `NULL` when a record's related field is empty (#28) minor fix in usage vignette (#32) Add usage vignette (#18) Add a simple unit test which queries laminlabs/lamindata (#27) bump action from v4.5.0 to v4 (#26)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add
print()andto_string()methods to the remaining R6 classes. Output tries to replicate the Python formatting except for some cases where the corresponding Python object doesn't have a print output.