From c3af0c620e9a80edf2074a40bc97eb1f6039a0bc Mon Sep 17 00:00:00 2001 From: Andrew Singleton Date: Wed, 15 Nov 2023 16:44:27 +0100 Subject: [PATCH] Update README --- README.Rmd | 8 +------- README.md | 21 ++++++++------------- 2 files changed, 9 insertions(+), 20 deletions(-) diff --git a/README.Rmd b/README.Rmd index 97c2688..2334b95 100644 --- a/README.Rmd +++ b/README.Rmd @@ -4,12 +4,6 @@ output: github_document - - ```{r setup, include = FALSE} knitr::opts_chunk$set( collapse = FALSE, @@ -18,7 +12,7 @@ knitr::opts_chunk$set( out.width = "100%" ) ``` -# harpIO +# harpIO {harpIO} provides a set of read and write functions for harp plus the option to transform gridded data to point data, cross sections or other grids at read time. {harpIO} is able to read _grib1_, _grib2_, _FA_, _NetCDF_ and _vfld_ files from weather forecast / climate models; station observations from _vobs_ files, radar / satellite observations from _HDF5_ files and in the future from in-house databases at selected meteorological institutes. Some of these formats require support packages to be installed and you will be given advice on which packages to install when you attempt to read those data. diff --git a/README.md b/README.md index 4283897..b7701f1 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,7 @@ - - -# harpIO +# harpIO {harpIO} provides a set of read and write functions for harp plus the option to transform gridded data to point data, cross sections or other @@ -65,7 +59,8 @@ If you include these environment variables in your .bashrc file, or equivalent, you won’t need to worry about it when you wish to install an update to meteogrid. -Or you can set compiler and linker options in the file $HOME/.R/Makevars +Or you can set compiler and linker options in the file +\$HOME/.R/Makevars ``` bash CPPFLAGS=-I/path/to/proj/include @@ -102,11 +97,11 @@ When data are interpolated to points it is possible to save the result to [SQLite](https://www.sqlite.org/) files. These are portable database files that allow fast access to the data with the ability to select and filter what you wish to read. You can tell `read_forecast()` to output -point data to SQLite files by setting the argument `output_file_opts = -sqlite_opts(path = "/path/to/output")`. These data can then be read with -`read_point_forecast()`. For gridded data there is generally no -advantage to outputting to another format, so this option is only -available if data are either point data to begin with, or +point data to SQLite files by setting the argument +`output_file_opts = sqlite_opts(path = "/path/to/output")`. These data +can then be read with `read_point_forecast()`. For gridded data there is +generally no advantage to outputting to another format, so this option +is only available if data are either point data to begin with, or `transformation = "interpolate"`. ## Reading observation data