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

Cosmetic fixes to get-started #102

Merged
merged 3 commits into from
Nov 22, 2024
Merged

Cosmetic fixes to get-started #102

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
775c7ac
Cosmetic fixes
falexwolf Nov 22, 2024
410e97d
Add dependencies
falexwolf Nov 22, 2024
4916b6f
Prettify
falexwolf Nov 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
9 changes: 4 additions & 5 deletions vignettes/laminr.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ lamin connect <owner>/<name>
```

This instance acts as the default instance for everything that follows.
Any new records or other changes will be added here.
Any data and tracking information will be added to it.

# Connect to the default instance
# Start an R session
Copy link
Collaborator

Choose a reason for hiding this comment

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

I changed this before as I find "Start an R session" confusing as users already need to have an R session to run the commands

Copy link
Member Author

Choose a reason for hiding this comment

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

But then we need another heading. We can call it "Start an analysis session in R".

The commands above are all on the terminal except the install.packages line.

Copy link
Member Author

Choose a reason for hiding this comment

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

Or "Start your analysis"

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll make this fix.


Load **{laminr}** to get started.

Expand All @@ -55,7 +55,6 @@ Create your default database `db` object for this R session:

```{r connect-default}
db <- connect()
db
Copy link
Member Author

Choose a reason for hiding this comment

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

I removed it because it confusingly displays cellxgene -- see discussion in other PR.

```

It is used to manage all datasets and metadata entities.
Expand All @@ -72,10 +71,10 @@ db$track("I8BlHXFXqZOG0000", path = "laminr.Rmd")
<div class="alert alert-info" role="alert">
**Tip**

The UID (here "I8BlHXFXqZOG0000") is obtained by running `db$track(path = "your_file.R")` and copying the UID from the output.
The UID (here `"I8BlHXFXqZOG0000"`) is obtained by running `db$track(path = "your_file.R")` and copying the UID from the output.
</div>

## Connect to other instances
# Connect to other instances

It is possible to connect to any LaminDB instance for reading data.
Connect to the public CELLxGENE instance:
Expand Down
Loading