diff --git a/index.html b/index.html index d7ac600..cc82a14 100644 --- a/index.html +++ b/index.html @@ -92,49 +92,35 @@

Demo

Initialize the database

First, you need to initialize the database and add figures to it.

-

```{r, eval=FALSE} library(ggfigdone)

+
+library(ggfigdone)
+
+## Initial ggfigdone database using `fd_init`
+## The database location is `./fd_dir`
+fo = fd_init("./fd_dir", rm_exist = T)
+
+## Draw a ggplot figure
+g = ggplot(mtcars, aes(x=wt, y=mpg)) + geom_point()
+
+## Add the figure to the database
+fd_add(g = g, name  = "fig1", fo, overwrite = T)
+
+## Add the same figure with a different name
+fd_add(g = g, name  = "fig2", fo, overwrite = T)
+
+## The hard disk database is automatically updated, no need to save operations.
+
+

Manage the figures in browser +

+

Then you can start the server and open the browser to manage the figures.

+
+## Load the database
+fo = fd_load("./fd_dir")
+
+## Start the server and open the browser
+fd_server("./fd_dir")
-
-

Initial ggfigdone database using fd_init - -

-
-
-

The database location is ./fd_dir - -

-

fo = fd_init(“./fd_dir”, rm_exist = T)

-
-
-

Draw a ggplot figure -

-

g = ggplot(mtcars, aes(x=wt, y=mpg)) + geom_point()

-
-
-

Add the figure to the database -

-

fd_add(g = g, name = “fig1”, fo, overwrite = T)

-
-
-

Add the same figure with a different name -

-

fd_add(g = g, name = “fig2”, fo, overwrite = T)

-
-
-

The hard disk database is automatically updated, no need to save operations. -

-

-### Manage the figures in browser
-
-Then you can start the server and open the browser to manage the figures.
-
-```{r, eval=FALSE}
-## Load the database
-fo = fd_load("./fd_dir")
-
-## Start the server and open the browser
-fd_server("./fd_dir")

Contribution diff --git a/pkgdown.yml b/pkgdown.yml index 3152654..52f8870 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,4 +2,4 @@ pandoc: 3.2.1 pkgdown: 2.1.0.9000 pkgdown_sha: 1d40a80e6b3564a6d7da0ce467b0a4570aa5665e articles: {} -last_built: 2024-08-09T14:36Z +last_built: 2024-08-09T14:38Z diff --git a/reference/fd_add.html b/reference/fd_add.html index 0d79150..96fe2e7 100644 --- a/reference/fd_add.html +++ b/reference/fd_add.html @@ -115,6 +115,8 @@

Examples

## Initial ggfigdone database using `fd_init` db_dir = file.path(tempdir(), "fd_add_exp") fo = fd_init(db_dir, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. ## Draw a ggplot figure @@ -135,7 +137,7 @@

Examples

#> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_add_exp #> ## Number of figures: 2 -#> ## Last updated date: 2024-08-09 16:36:50 +#> ## Last updated date: 2024-08-09 16:38:56
diff --git a/reference/fd_init.html b/reference/fd_init.html index c4af7a4..fafadb4 100644 --- a/reference/fd_init.html +++ b/reference/fd_init.html @@ -86,11 +86,13 @@

Examples

## Initate the ggfigdone database fd_init(db_dir, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. #> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_init #> ## Number of figures: 0 -#> ## Last updated date: 2024-08-09 16:36:51.388144 +#> ## Last updated date: 2024-08-09 16:38:57.234115 diff --git a/reference/fd_load.html b/reference/fd_load.html index b9fbb60..ce7054b 100644 --- a/reference/fd_load.html +++ b/reference/fd_load.html @@ -77,11 +77,13 @@

Examples

## create ggfigdone database in a temporary directory db_dir = file.path(tempdir(), "fd_load") fd_init(db_dir, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. #> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_load #> ## Number of figures: 0 -#> ## Last updated date: 2024-08-09 16:36:51.679852 +#> ## Last updated date: 2024-08-09 16:38:57.516793 ## Load the ggfigdone database fd_load(db_dir) @@ -89,7 +91,7 @@

Examples

#> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_load #> ## Number of figures: 0 -#> ## Last updated date: 2024-08-09 16:36:51.71277 +#> ## Last updated date: 2024-08-09 16:38:57.518815 diff --git a/reference/fd_merge.html b/reference/fd_merge.html index 9ac57bc..a52dc75 100644 --- a/reference/fd_merge.html +++ b/reference/fd_merge.html @@ -85,8 +85,12 @@

Examples

db_dir1 = file.path(tempdir(), "db1") db_dir2 = file.path(tempdir(), "db2") fo1 = fd_init(db_dir1, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. fo2 = fd_init(db_dir2, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. ## Draw a ggplot figure @@ -108,7 +112,7 @@

Examples

#> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/db2 #> ## Number of figures: 2 -#> ## Last updated date: 2024-08-09 16:36:52 +#> ## Last updated date: 2024-08-09 16:38:58 ## diff --git a/reference/fd_unique.html b/reference/fd_unique.html index 3cb52cb..9b7a018 100644 --- a/reference/fd_unique.html +++ b/reference/fd_unique.html @@ -80,6 +80,8 @@

Examples

## create ggfigdone database in a temporary directory db_dir = file.path(tempdir(), "fd_unique") fo = fd_init(db_dir, rm_exist = TRUE) +#> The directory already exists, and is not empty. +#> The directory content is removed. #> The database version is up-to-date. ## Draw a ggplot figure @@ -102,14 +104,14 @@

Examples

#> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_unique #> ## Number of figures: 1 -#> ## Last updated date: 2024-08-09 16:36:53 +#> ## Last updated date: 2024-08-09 16:38:59 ## Show the updated ggfigdone database print(fo) #> ########## #> ## ggfigdone database: /tmp/Rtmp7ds0uT/fd_unique #> ## Number of figures: 1 -#> ## Last updated date: 2024-08-09 16:36:53 +#> ## Last updated date: 2024-08-09 16:38:59