Skip to content

Commit 9d6ea89

Browse files
committed
Update README
1 parent 5828977 commit 9d6ea89

File tree

2 files changed

+18
-25
lines changed

2 files changed

+18
-25
lines changed

README.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ pd.set_option("display.notebook_repr_html", False)
99

1010
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/machow/pins-python/HEAD)
1111

12-
The pins package publishes data, models, and other python objects, making it
12+
The pins package publishes data, models, and other Python objects, making it
1313
easy to share them across projects and with your colleagues. You can pin
1414
objects to a variety of pin *boards*, including folders (to share on a
1515
networked drive or with services like DropBox), RStudio Connect, and Amazon
@@ -41,7 +41,7 @@ from pins.data import mtcars
4141
board = pins.board_temp()
4242
```
4343

44-
You can pin (save) data to a board with the `.pin_write()` method. It requires three
44+
You can "pin" (save) data to a board with the `.pin_write()` method. It requires three
4545
arguments: an object, a name, and a pin type:
4646

4747
```{python}
@@ -61,7 +61,7 @@ board.pin_read("mtcars")
6161
A board on your computer is good place to start, but the real power of
6262
pins comes when you use a board that’s shared with multiple people. To
6363
get started, you can use `board_folder()` with a directory on a shared
64-
drive or in dropbox, or if you use [RStudio
64+
drive or in DropBox, or if you use [RStudio
6565
Connect](https://www.rstudio.com/products/connect/) you can use
6666
`board_rsconnect()`:
6767

README.md

Lines changed: 15 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,19 @@ from pins.data import mtcars
3535
board = pins.board_temp()
3636
```
3737

38-
You can pin (save) data to a board with the `.pin_write()` method. It requires three
38+
You can "pin" (save) data to a board with the `.pin_write()` method. It requires three
3939
arguments: an object, a name, and a pin type:
4040

4141

4242
```python
4343
board.pin_write(mtcars.head(), "mtcars", type="csv")
4444
```
4545

46-
Writing to pin 'mtcars'
47-
48-
49-
50-
51-
52-
Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20220518T150837Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2022, 5, 18, 15, 8, 37, 413288), hash='120a54f7e0818041'), name='mtcars', user={})
53-
54-
46+
```
47+
## Meta(title='mtcars: a pinned 5 x 11 DataFrame', description=None, created='20220524T122819Z', pin_hash='120a54f7e0818041', file='mtcars.csv', file_size=249, type='csv', api_version=1, version=Version(created=datetime.datetime(2022, 5, 24, 12, 28, 19, 765459), hash='120a54f7e0818041'), name='mtcars', user={})
48+
##
49+
## Writing to pin 'mtcars'
50+
```
5551

5652
Above, we saved the data as a CSV, but depending on
5753
what you’re saving and who else you want to read it, you might use the
@@ -64,22 +60,19 @@ You can later retrieve the pinned data with `.pin_read()`:
6460
board.pin_read("mtcars")
6561
```
6662

67-
68-
69-
70-
mpg cyl disp hp drat wt qsec vs am gear carb
71-
0 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
72-
1 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
73-
2 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
74-
3 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
75-
4 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
76-
77-
63+
```
64+
## mpg cyl disp hp drat wt qsec vs am gear carb
65+
## 0 21.0 6 160.0 110 3.90 2.620 16.46 0 1 4 4
66+
## 1 21.0 6 160.0 110 3.90 2.875 17.02 0 1 4 4
67+
## 2 22.8 4 108.0 93 3.85 2.320 18.61 1 1 4 1
68+
## 3 21.4 6 258.0 110 3.08 3.215 19.44 1 0 3 1
69+
## 4 18.7 8 360.0 175 3.15 3.440 17.02 0 0 3 2
70+
```
7871

7972
A board on your computer is good place to start, but the real power of
8073
pins comes when you use a board that’s shared with multiple people. To
8174
get started, you can use `board_folder()` with a directory on a shared
82-
drive or in dropbox, or if you use [RStudio
75+
drive or in DropBox, or if you use [RStudio
8376
Connect](https://www.rstudio.com/products/connect/) you can use
8477
`board_rsconnect()`:
8578

0 commit comments

Comments
 (0)