Preparation
-In order to get started with DataEditR, we will need to install the package from GitHub and load it into our current R session:
-devtools::install_github("DillonHammill/DataEditR") +In order to get started with DataEditR, we will need to install the package from CRAN and load it into our current R session:
++install.packages("DataEditR") library(DataEditR)If you would like to use the development version of DataEditR it can be installed directly from GitHub:
+devtools::install_github("DillonHammill/DataEditR")
1. Data Visualisation
Simply supply your data in the form of a matrix, data.frame or data.table to data_edit() to view it in an interactive table. For example, if we wanted to take a look at the mtcars dataset:
data_edit(mtcars)
data_edit(mtcars)
The data editor will open in the RStudio viewer pane by default but this can be changed to a pop-up window by setting viewer = FALSE as below. Both of these options have optional support for displaying the data in a web browser as well.
data_edit(mtcars, +data_edit(mtcars, viewer = FALSE)The data editor will automatically move row names inside the table so that the row indices can be displayed on the left hand side. Once you are finished exploring the data, you can close the data editor by hitting the
Save & Closebutton in the top left corner.
2. Data Import
data_edit() can all read in any form tabular data from file for viewing and editing. By default data_edit() will use read.csv from the utils package to read in files, but this can be changed to any reading function by supplying the name of the function to the read_fun argument. If you need to pass any additional arguments to your reading function, these can be supplied as a named list to the read_args argument. The data will be returned by data_edit() once the Save & Close button has been clicked.
mtcars <- data_edit("mtcars.csv", +@@ -133,38 +135,38 @@mtcars <- data_edit("mtcars.csv", read_fun = "read.csv", read_args = list(header = TRUE)) head(mtcars)
3.1 Addition or removal of rows or columns
Rows or columns can be added to the data from within the data editor by right clicking on a cell within the table. This will display a context menu with the options to add or remove rows or columns.
-+data_edit(mtcars)data_edit(mtcars)
3.2 Rename rows or columns
data_edit() has full support for editing row and column names. Simply select the cell that you want to edit and update its value within the table. As outlined above, the row names will appear within the table so that the row indices can be displayed on the left-hand side. The row indices cannot be edited. The new row or column names must be unique!
data_edit(mtcars)
data_edit(mtcars)
To prevent users from editing column names, set col_names = FALSE or supply the names of the columns that cannot be edited. For example, if we only wanted to prevent users from editing the name of the mpg column:
3.3 Resize columns
To size columns, go to the right-hand border of the cell containing the name of that column and drag the cursor to the desired width.
-data_edit(mtcars)
data_edit(mtcars)
3.4 Drag to fill
Values in cells can be dragged to other cells by selecting the filled cells and dragging the box in the lower right hand corner.
-data_edit(mtcars)
data_edit(mtcars)
3.5 Append columns or rows
data_edit() can perform rbind and cbind operations internally to append new rows or columns to the data prior to editing. The new rows or columns should be supplied as a matrix or data.frame to the row_bind or col_bind arguments. If binding both rows and columns, it is important to note that rows are bound before columns.
# New column to add +@@ -190,22 +192,24 @@# New column to add new_col <- matrix(rep(NA, nrow(mtcars)), ncol = 1, dimnames = list(NULL, "test")) @@ -178,7 +180,7 @@
3.6 Read-only columns
If you would like to prevent values from being edited in certain columns, you can supply the names of the columns that cannot be edited to the
-col_readonlyargument. Users will be able to edit values and the column name, but these will be reverted to the original values. For example, if we wanted to prevent thempgcolumn from being edited:
4.1 Start with empty data.frame
If no data is supplied to
- +data_edit()an empty data.frame will be constructed with a single row and column. You can then build your data.frame from scratch by adding new rows and columns and annotating the cells.
4.2 Start with a template data.frame
Creating a data.frame from scratch as described above can be tedious, so instead we could start with a data.frame template that contains more rows or columns. To create a template data.frame, simply supply the required dimensions of the data.frame in the form c(nrow, ncol).
Alternatively, you can pass a vector of column names to create a data.frame template with pre-defined column names. You will need to install the development version DataEditR from GitHub to use this feature.
+5. Data saving
data_edit() will automatically return the edited data with appropriate column classes as an R object for use within R. Character columns are not converted to factors by default, but this can be changed by setting col_factor = TRUE.
# Add character column +diff --git a/vignettes/DataEditR.Rmd b/vignettes/DataEditR.Rmd index 246dd63..c4207b9 100644 --- a/vignettes/DataEditR.Rmd +++ b/vignettes/DataEditR.Rmd @@ -30,13 +30,18 @@ readr::write_lines(html, path = "logo.html") ## Preparation -In order to get started with **DataEditR**, we will need to install the package from GitHub and load it into our current R session: +In order to get started with **DataEditR**, we will need to install the package from CRAN and load it into our current R session: ```{r, eval = FALSE} -devtools::install_github("DillonHammill/DataEditR") +install.packages("DataEditR") library(DataEditR) ``` +If you would like to use the development version of **DataEditR** it can be installed directly from GitHub: +```{r, eval = FALSE} +devtools::install_github("DillonHammill/DataEditR") +``` + ## 1. Data Visualisation Simply supply your data in the form of a matrix, data.frame or data.table to `data_edit()` to view it in an interactive table. For example, if we wanted to take a look at the `mtcars` dataset: @@ -188,6 +193,12 @@ data_edit(c(3, 3)) knitr::include_graphics('https://raw.githubusercontent.com/DillonHammill/DataEditR/master/vignettes/DataEditR/DataEditR-8.gif') ``` +Alternatively, you can pass a vector of column names to create a data.frame template with pre-defined column names. You will need to install the development version **DataEditR** from GitHub to use this feature. + +```{r, eval = FALSE} +data_edit(c("Player", "Age", "Titles")) +``` + ## 5. Data saving `data_edit()` will automatically return the edited data with appropriate column classes as an R object for use within R. Character columns are not converted to factors by default, but this can be changed by setting `col_factor = TRUE`.# Add character column mtcars_new <- cbind(rownames(mtcars), mtcars) colnames(mtcars_new) <- "car" @@ -227,7 +231,7 @@#> $ gear: num 4 4 4 3 3 3 3 4 4 4 ... #> $ carb: num 4 4 1 1 2 1 4 2 2 4 ...
The edited data can also be written to a file of any format by specifying the name of the file to the
-save_asargument and specifying the name of the writing function to use throughwrite_fun. The default is to usewrite.csvfrom theutilspackage. You can also pass any additional arguments to your write function in a named list towrite_args.+mtcars_new <- data_edit(mtcars, +@@ -125,9 +125,18 @@mtcars_new <- data_edit(mtcars, save_as = "mtcars.csv", write_fun = "write.table", write_args = list(sep = ",", @@ -241,7 +245,7 @@
6.1 Checkboxes
Checkboxes can be used to obtain TRUE or FALSE value inputs from users. The resulting data will have a value of TRUE or NA based on user input.
-diff --git a/docs/news/index.html b/docs/news/index.html index 965c434..15f943d 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -79,7 +79,7 @@data_edit(mtcars, +@@ -250,7 +254,7 @@
6.2 Dropdown menus
Dropdown menus can be used to help prevent typing errors when set number of options are available for a column. For example, if we have a factor with levels
-Treatment-A,Treatment-BorTreatment-Cit would be easier to select these options from a dropdown menu instead of having to manually type them. Dropdown menus can be added in the same way as checkboxes.@@ -166,6 +166,8 @@# Add column for car colour +# Add column for car colour data_edit(mtcars, col_bind = "col", col_options = list(col = c("red", @@ -269,14 +273,14 @@
7.1 Stretch columns to fill page
If you would like to make full use of the space available to you, you can set
-col_stretch = TRUEto stretch the columns to fill the full width of the display.@@ -146,7 +146,7 @@7.2 Logo and title
-
data_edit()does also have support for adding a logo and/or title to the data editor. For example, if you wanted to usedata_edit()within your own package you can customise it with your packagelogoand instructions to the user throughtitle.diff --git a/docs/index.html b/docs/index.html index fd95a18..3c0299c 100644 --- a/docs/index.html +++ b/docs/index.html @@ -40,7 +40,7 @@car_logo <- 'https://raw.githubusercontent.com/DillonHammill/DataEditR/master/vignettes/DataEditR/DataEditR-Car.png' +diff --git a/docs/authors.html b/docs/authors.html index d2424d8..5be85a0 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -79,7 +79,7 @@car_logo <- 'https://raw.githubusercontent.com/DillonHammill/DataEditR/master/vignettes/DataEditR/DataEditR-Car.png' data_edit(mtcars, logo = car_logo, logo_size = 100, @@ -287,7 +291,7 @@
7.3 Custom themes
- diff --git a/docs/articles/index.html b/docs/articles/index.html index 01276ec..0c149ab 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -79,7 +79,7 @@
data_edit()makes use of theshinythemespackage to customise the appearance of the data editor. You can explore the different themes by supplying the name of a validshinythemestheme to thethemeargument.#> To cite package 'DataEditR' in publications use: #> #> Dillon Hammill (2020). DataEditR: An Interactive Editor for Viewing, -#> Entering & Editing Data. R package version 0.0.5. +#> Entering & Editing Data. R package version 0.0.6. #> https://github.com/DillonHammill/DataEditR #> #> A BibTeX entry for LaTeX users is @@ -155,7 +155,7 @@
#> title = {DataEditR: An Interactive Editor for Viewing, Entering & Editing Data}, #> author = {Dillon Hammill}, #> year = {2020}, -#> note = {R package version 0.0.5}, +#> note = {R package version 0.0.6}, #> url = {https://github.com/DillonHammill/DataEditR}, #> }
Links
+
- Download from CRAN at
https://cloud.r-project.org/package=DataEditR +- Browse source code at
https://github.com/DillonHammill/DataEditR/- Report a bug at
https://github.com/DillonHammill/DataEditR/issues @@ -197,6 +199,8 @@Dev status
- +
- +
Changelog
Source:NEWS.md++DataEditR 0.0.6 Unreleased +
++
+- Add ability to pass column names to
+data_edit()to construct a template data.frame with pre-defined column names.-DataEditR 0.0.5
+DataEditR 0.0.5 2020-08-12 +
- Fix row indices when rows are added or removed.
- Improve handling of duplicate row indices in case of accidental editing.
@@ -135,7 +144,8 @@
-DataEditR 0.0.4
+DataEditR 0.0.4 Unreleased +
- Add
col_readonlyargument to prevent users from editing values or column names of certain columns.- Prevent error when column is clicked but not edited.
@@ -143,21 +153,24 @@
-DataEditR 0.0.3
+DataEditR 0.0.3 Unreleased +
- Add
col_namesargument to allow control over which column names can be edited by the user.diff --git a/docs/reference/index.html b/docs/reference/index.html index 4a1c27d..8abcb29 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -79,7 +79,7 @@-DataEditR 0.0.1
+DataEditR 0.0.1 Unreleased +diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 3e42adc..e9edef8 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 1.5.1 pkgdown_sha: ~ articles: DataEditR: DataEditR.html -last_built: 2020-08-09T07:21Z +last_built: 2020-08-25T00:11Z diff --git a/docs/reference/data_edit.html b/docs/reference/data_edit.html index 7c3fcbf..7a44099 100644 --- a/docs/reference/data_edit.html +++ b/docs/reference/data_edit.html @@ -83,7 +83,7 @@
- Add
data_edit()to allow interactive data viewing, entry and editing.
