diff --git a/README.Rmd b/README.Rmd index c2598a6..60c4b39 100644 --- a/README.Rmd +++ b/README.Rmd @@ -17,7 +17,6 @@ version <- as.character(packageVersion("isoreader")) # isoreader [![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/isoreader)](https://cran.r-project.org/package=isoreader) -[![Git_Hub_Version](https://img.shields.io/badge/GitHub-`r version`-purple.svg?style=flat-square)](https://github.com/isoverse/isoreader/commits) [![Documentation](https://img.shields.io/badge/docs-online-green.svg)](https://isoreader.isoverse.org/) [![R build status](https://github.com/isoverse/isoreader/workflows/R-CMD-check/badge.svg)](https://github.com/isoverse/isoreader/actions?workflow=R-CMD-check) [![Binder](https://img.shields.io/badge/explore%20online-in%20RStudio-blue.svg)](https://mybinder.org/v2/gh/isoverse/isoreader/binder?urlpath=rstudio) diff --git a/README.md b/README.md index b2fcf3b..01570d6 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,6 @@ # isoreader [![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/isoreader)](https://cran.r-project.org/package=isoreader) -[![Git\_Hub\_Version](https://img.shields.io/badge/GitHub-1.3.0-purple.svg?style=flat-square)](https://github.com/isoverse/isoreader/commits) -[![DOI](https://joss.theoj.org/papers/10.21105/joss.02878/status.svg)](https://doi.org/10.21105/joss.02878) [![Documentation](https://img.shields.io/badge/docs-online-green.svg)](https://isoreader.isoverse.org/) [![R build status](https://github.com/isoverse/isoreader/workflows/R-CMD-check/badge.svg)](https://github.com/isoverse/isoreader/actions?workflow=R-CMD-check) @@ -78,8 +76,8 @@ devtools::install_github("isoverse/isoreader") Troubleshooting note: depending on your workspace and operating system, you may have to re-start your R session or manually install some dependencies. For example, the `digest` package sometimes causes trouble -- re-install with `remove.packages("digest"); -install.packages("digest")`. +- re-install with +`remove.packages("digest"); install.packages("digest")`. ## Show me some code @@ -100,17 +98,17 @@ iso_files <- iso_read_scan(data_folder) #> Info: reading file 'full_scan_example.scn' with '.scn' reader... #> Info: reading file 'peak_shape_scan_example.scn' with '.scn' reader... #> Info: reading file 'time_scan_example.scn' with '.scn' reader... -#> Info: finished reading 4 files in 0.99 secs +#> Info: finished reading 4 files in 0.82 secs iso_files #> Data from 4 scan iso files: -#> # A tibble: 4 x 5 -#> file_id raw_data file_info method_info file_path -#> -#> 1 background_sca… 525 measurements, 7 io… 8 entries resistors background_scan… -#> 2 full_scan_exam… 799 measurements, 3 ch… 8 entries resistors full_scan_examp… -#> 3 peak_shape_sca… 220 measurements, 3 io… 8 entries resistors peak_shape_scan… -#> 4 time_scan_exam… 5532 measurements, 2 i… 8 entries resistors time_scan_examp… +#> # A tibble: 4 × 5 +#> file_id raw_data file_info method_info file_path +#> +#> 1 background_scan_example.scn 525 measuremen… 8 entries resistors background_… +#> 2 full_scan_example.scn 799 measuremen… 8 entries resistors full_scan_e… +#> 3 peak_shape_scan_example.scn 220 measuremen… 8 entries resistors peak_shape_… +#> 4 time_scan_example.scn 5532 measureme… 8 entries resistors time_scan_e… ``` ## Supported File Types @@ -118,7 +116,7 @@ iso_files Currently supported file types: | type | extension | software | description | -| :-------------- | :-------- | :-------- | :---------------------------------- | +|:----------------|:----------|:----------|:------------------------------------| | continuous flow | .cf | Isodat | Continuous Flow file format (older) | | continuous flow | .cf.rds | isoreader | R Data Storage | | continuous flow | .dxf | Isodat | Continuous Flow file format (newer) | @@ -132,21 +130,21 @@ Currently supported file types: ## Documentation - - for a quick introduction, check out the aforementioned [**Quick +- for a quick introduction, check out the aforementioned [**Quick Start Vignette**](https://isoreader.isoverse.org/articles/quick_start.html) - - for a full reference of all available functions, see the **[Function +- for a full reference of all available functions, see the **[Function Reference](https://isoreader.isoverse.org/reference/)** - - for function help within RStudio, simply start typing `?iso_` in the +- for function help within RStudio, simply start typing `?iso_` in the console and a list of available function will appear (all functions share the `iso_` prefix) - - for a detailed example of how to work with continuous flow data +- for a detailed example of how to work with continuous flow data files, see the vignette on **[Continuous Flow](https://isoreader.isoverse.org/articles/continuous_flow.html)** - - for a detailed example of how to work with dual inlet data files, +- for a detailed example of how to work with dual inlet data files, see the vignette on **[Dual Inlet](https://isoreader.isoverse.org/articles/dual_inlet.html)** - - for a detailed example of how to work with scan data files, see the +- for a detailed example of how to work with scan data files, see the vignette on **[Scans](https://isoreader.isoverse.org/articles/scan.html)** @@ -168,7 +166,7 @@ please take a look at the development section below. ## Development -If you are interested in helping with development, that’s fantastic\! +If you are interested in helping with development, that’s fantastic! Please fork the repository and branch off from the [dev branch](https://github.com/isoverse/isoreader/tree/dev) since it contains the most up-to-date development version of @@ -176,10 +174,10 @@ contains the most up-to-date development version of [`testthat` tests](https://r-pkgs.org/tests.html) for your work (stored in the tests/testthat directory). All tests can be run automatically and continuously during development to make it easier to spot any code -problems on the go. The easiest way to run them is by running `make -auto_test` in the [isoreader](https://isoreader.isoverse.org/) directory -from command line (it will test everything automatically in a completely -separate R session). +problems on the go. The easiest way to run them is by running +`make auto_test` in the [isoreader](https://isoreader.isoverse.org/) +directory from command line (it will test everything automatically in a +completely separate R session). ## Open Source