Skip to content

Commit

Permalink
Cosmetic fixes to get-started (#102)
Browse files Browse the repository at this point in the history
* Cosmetic fixes

* Add dependencies

* Prettify
  • Loading branch information
falexwolf authored Nov 22, 2024
1 parent be67448 commit 969b610
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions vignettes/laminr.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This vignette introduces the basic **{laminr}** workflow.
Install **{laminr}** from CRAN:

```r
install.packages("laminr")
install.packages("laminr", dependencies = TRUE)
```

Install `lamindb` from PyPI:
Expand All @@ -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 your analysis

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

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

```{r connect-default}
db <- connect()
db
```

It is used to manage all datasets and metadata entities.

# Track data lineage

LaminDB can track which scripts or notebooks were used to create data.
LaminDB tracks which code is used to create data.
To track the current source code, run:

```{r track, eval = submit_eval}
Expand All @@ -72,10 +69,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

0 comments on commit 969b610

Please sign in to comment.