Skip to content

Commit

Permalink
Add images in and render README
Browse files Browse the repository at this point in the history
  • Loading branch information
ateucher committed May 24, 2022
1 parent cbc9cba commit 4cd2e97
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 27 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@

.dipr/
docs
.DS_Store
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ if (!file.exists("man/figures/logo.png") &&
}
```

# dipr <!-- <img src='man/figures/logo.png' align="right" height="139" /> -->
# dipr <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->
<!-- [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -->
<!-- [![R build status](https://github.com/bcgov/dipr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/dipr) -->
<!-- [![img](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) -->
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![R build status](https://github.com/bcgov/dipr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/dipr)
[![img](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
<!-- badges: end -->


Expand Down
44 changes: 21 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# dipr <!-- <img src='man/figures/logo.png' align="right" height="139" /> -->
# dipr <img src='man/figures/logo.png' align="right" height="139" />

<!-- badges: start -->

<!-- [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) -->

<!-- [![R build status](https://github.com/bcgov/dipr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/dipr) -->

<!-- [![img](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md) -->

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![R build
status](https://github.com/bcgov/dipr/workflows/R-CMD-check/badge.svg)](https://github.com/bcgov/dipr)
[![img](https://img.shields.io/badge/Lifecycle-Experimental-339999)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
<!-- badges: end -->

The `dipr` package is an R package that loads and provides means of
Expand Down Expand Up @@ -101,18 +99,18 @@ directly read \`.dat.gz files:
``` r
raw <- read_dat(data_path = dat_path,
data_dict = dict)
#> v Reading starwars-fwf
#> Reading starwars-fwf
#> Rows: 15 Columns: 6
#> -- Column specification --------------------------------------------------------
#> ── Column specification ────────────────────────────────────────────────────────
#>
#> chr (2): name, species
#> dbl (3): height, mass, date
#> lgl (1): has_hair
#>
#> i Use `spec()` to retrieve the full column specification for this data.
#> i Specify the column types or set `show_col_types = FALSE` to quiet this message.
#> Use `spec()` to retrieve the full column specification for this data.
#> Specify the column types or set `show_col_types = FALSE` to quiet this message.
head(raw)
#> # A tibble: 6 x 6
#> # A tibble: 6 × 6
#> name height mass has_hair species date
#> <chr> <dbl> <dbl> <lgl> <chr> <dbl>
#> 1 Luke Skywalker 172 77 FALSE Human 19871219
Expand All @@ -134,16 +132,16 @@ raw_two_files <- read_dat(
data_dict = dict,
id = "file"
)
#> v Reading starwars-fwf and starwars-fwf2
#> Reading starwars-fwf and starwars-fwf2
#> Rows: 30 Columns: 7
#> -- Column specification --------------------------------------------------------
#> ── Column specification ────────────────────────────────────────────────────────
#>
#> chr (2): name, species
#> dbl (3): height, mass, date
#> lgl (1): has_hair
#>
#> i Use `spec()` to retrieve the full column specification for this data.
#> i Specify the column types or set `show_col_types = FALSE` to quiet this message.
#> Use `spec()` to retrieve the full column specification for this data.
#> Specify the column types or set `show_col_types = FALSE` to quiet this message.
```

Working with the data.table package for data manipulation is also
Expand All @@ -154,16 +152,16 @@ raw_dt <- read_dat_dt(
data_path = dat_path,
data_dict = dict
)
#> v Reading starwars-fwf
#> Reading starwars-fwf
#> Rows: 15 Columns: 6
#> -- Column specification --------------------------------------------------------
#> ── Column specification ────────────────────────────────────────────────────────
#>
#> chr (2): name, species
#> dbl (3): height, mass, date
#> lgl (1): has_hair
#>
#> i Use `spec()` to retrieve the full column specification for this data.
#> i Specify the column types or set `show_col_types = FALSE` to quiet this message.
#> Use `spec()` to retrieve the full column specification for this data.
#> Specify the column types or set `show_col_types = FALSE` to quiet this message.
```

### Data Dictionary
Expand All @@ -185,13 +183,13 @@ Under development
## License

Copyright 2019 Province of British Columbia

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Expand Down
Binary file added man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4cd2e97

Please sign in to comment.