Browse Source

README

master
boB Rudis 3 years ago
parent
commit
70666d566a
No known key found for this signature in database GPG Key ID: 1D7529BE14E2BBA9
  1. 21
      README.Rmd
  2. 203
      README.md

21
README.Rmd

@ -1,8 +1,10 @@
---
output: rmarkdown::github_document
output:
rmarkdown::github_document:
df_print: kable
---
[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active)
[![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/0.1.0/active.svg)](https://www.repostatus.org/#active)
[![Travis-CIBuild Status](https://travis-ci.org/hrbrmstr/simplemagic.svg?branch=master)](https://travis-ci.org/hrbrmstr/simplemagic)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/hrbrmstr/simplemagic?branch=master&svg=true)](https://ci.appveyor.com/project/hrbrmstr/simplemagic)
[![Coverage Status](https://img.shields.io/codecov/c/github/hrbrmstr/simplemagic/master.svg)](https://codecov.io/github/hrbrmstr/simplemagic?branch=master)
@ -34,8 +36,8 @@ The following functions are implemented:
## Installation
```{r eval=FALSE}
devtools::install_git("https://gitlab.com/hrbrmstr/wand")
```{r install-ex, results='asis', echo = FALSE}
hrbrpkghelpr::install_block()
```
```{r message=FALSE, warning=FALSE, error=FALSE, include=FALSE}
@ -55,13 +57,18 @@ packageVersion("wand")
```{r}
list.files(system.file("extdat", package="wand"), full.names=TRUE) %>%
map_df(~{
data_frame(
tibble(
fil = basename(.x),
mime = list(get_content_type(.x))
)
}) %>%
unnest() %>%
print(n=100)
unnest()
```
## Package Code Metrics
```{r}
cloc::cloc_pkg_md()
```
## Code of Conduct

203
README.md

@ -1,7 +1,7 @@
[![Project Status: Active - The project has reached a stable, usable
state and is being actively
developed.](http://www.repostatus.org/badges/0.1.0/active.svg)](http://www.repostatus.org/#active)
developed.](https://www.repostatus.org/badges/0.1.0/active.svg)](https://www.repostatus.org/#active)
[![Travis-CIBuild
Status](https://travis-ci.org/hrbrmstr/simplemagic.svg?branch=master)](https://travis-ci.org/hrbrmstr/simplemagic)
[![AppVeyor Build
@ -44,7 +44,15 @@ The following functions are implemented:
## Installation
``` r
devtools::install_git("https://gitlab.com/hrbrmstr/wand")
install.packages("wand", repos = "https://cinc.rud.is")
# or
devtools::install_git("https://git.rud.is/hrbrmstr/wand.git")
# or
devtools::install_git("https://git.sr.ht/~hrbrmstr/wand")
# or
devtools::install_bitbucket("hrbrmstr/wand")
# or
devtools::install_github("hrbrmstr/wand")
```
## Usage
@ -57,108 +65,115 @@ library(tidyverse)
packageVersion("wand")
```
## [1] '0.3.0'
## [1] '0.5.0'
``` r
list.files(system.file("extdat", package="wand"), full.names=TRUE) %>%
map_df(~{
data_frame(
tibble(
fil = basename(.x),
mime = list(get_content_type(.x))
)
}) %>%
unnest() %>%
print(n=100)
unnest()
```
## # A tibble: 85 x 2
## fil mime
## <chr> <chr>
## 1 actions.csv application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
## 2 actions.txt application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
## 3 actions.xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
## 4 test_1.2.class application/java-vm
## 5 test_1.3.class application/java-vm
## 6 test_1.4.class application/java-vm
## 7 test_1.5.class application/java-vm
## 8 test_128_44_jstereo.mp3 audio/mp3
## 9 test_excel_2000.xls application/msword
## 10 test_excel_spreadsheet.xml application/xml
## 11 test_excel_web_archive.mht message/rfc822
## 12 test_excel.xlsm application/zip
## 13 test_excel.xlsx application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
## 14 test_nocompress.tif image/tiff
## 15 test_powerpoint.pptm application/zip
## 16 test_powerpoint.pptx application/vnd.openxmlformats-officedocument.presentationml.presentation
## 17 test_word_2000.doc application/msword
## 18 test_word_6.0_95.doc application/msword
## 19 test_word.docm application/zip
## 20 test_word.docx application/vnd.openxmlformats-officedocument.wordprocessingml.document
## 21 test.au audio/basic
## 22 test.bin application/mac-binary
## 23 test.bin application/macbinary
## 24 test.bin application/octet-stream
## 25 test.bin application/x-binary
## 26 test.bin application/x-macbinary
## 27 test.bmp image/bmp
## 28 test.dtd application/xml-dtd
## 29 test.emf application/x-msmetafile
## 30 test.eps application/postscript
## 31 test.fli video/flc
## 32 test.fli video/fli
## 33 test.fli video/x-fli
## 34 test.gif image/gif
## 35 test.ico image/x-icon
## 36 test.java text/plain
## 37 test.java text/x-java
## 38 test.java text/x-java-source
## 39 test.jpg image/jpeg
## 40 test.mp3 audio/mp3
## 41 test.odt application/vnd.oasis.opendocument.text
## 42 test.ogg application/ogg
## 43 test.ogg audio/ogg
## 44 test.pcx image/pcx
## 45 test.pcx image/x-pcx
## 46 test.pdf application/pdf
## 47 test.pl text/plain
## 48 test.pl text/x-perl
## 49 test.pl text/x-script.perl
## 50 test.png image/png
## 51 test.pnm application/x-portable-anymap
## 52 test.pnm image/x-portable-anymap
## 53 test.ppm image/x-portable-pixmap
## 54 test.ppt application/msword
## 55 test.ps application/postscript
## 56 test.psd image/photoshop
## 57 test.py text/x-python
## 58 test.py text/x-script.phyton
## 59 test.rtf application/rtf
## 60 test.rtf application/x-rtf
## 61 test.rtf text/richtext
## 62 test.rtf text/rtf
## 63 test.sh application/x-bsh
## 64 test.sh application/x-sh
## 65 test.sh application/x-shar
## 66 test.sh text/x-script.sh
## 67 test.sh text/x-sh
## 68 test.tar application/pax
## 69 test.tar.gz application/octet-stream
## 70 test.tar.gz application/x-compressed
## 71 test.tar.gz application/x-gzip
## 72 test.tga image/x-tga
## 73 test.txt text/plain
## 74 test.txt.gz application/octet-stream
## 75 test.txt.gz application/x-compressed
## 76 test.txt.gz application/x-gzip
## 77 test.wav audio/x-wav
## 78 test.wmf application/x-msmetafile
## 79 test.wmf windows/metafile
## 80 test.xcf application/x-xcf
## 81 test.xml application/xml
## 82 test.xpm image/x-xbitmap
## 83 test.xpm image/x-xpixmap
## 84 test.xpm image/xpm
## 85 test.zip application/zip
<div class="kable-table">
| fil | mime |
| :---------------------------- | :------------------------------------------------------------------------ |
| actions.csv | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| actions.txt | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| actions.xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| test\_128\_44\_jstereo.mp3 | audio/mp3 |
| test\_excel\_2000.xls | application/msword |
| test\_excel\_spreadsheet.xml | application/xml |
| test\_excel\_web\_archive.mht | message/rfc822 |
| test\_excel.xlsm | application/zip |
| test\_excel.xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| test\_nocompress.tif | image/tiff |
| test\_powerpoint.pptm | application/zip |
| test\_powerpoint.pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation |
| test\_word\_2000.doc | application/msword |
| test\_word\_6.0\_95.doc | application/msword |
| test\_word.docm | application/zip |
| test\_word.docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document |
| test.au | audio/basic |
| test.bin | application/mac-binary |
| test.bin | application/macbinary |
| test.bin | application/octet-stream |
| test.bin | application/x-binary |
| test.bin | application/x-macbinary |
| test.bmp | image/bmp |
| test.dtd | application/xml-dtd |
| test.emf | application/x-msmetafile |
| test.eps | application/postscript |
| test.fli | video/flc |
| test.fli | video/fli |
| test.fli | video/x-fli |
| test.gif | image/gif |
| test.ico | image/x-icon |
| test.jpg | image/jpeg |
| test.mp3 | audio/mp3 |
| test.odt | application/vnd.oasis.opendocument.text |
| test.ogg | application/ogg |
| test.ogg | audio/ogg |
| test.pcx | image/pcx |
| test.pcx | image/x-pcx |
| test.pdf | application/pdf |
| test.pl | text/plain |
| test.pl | text/x-perl |
| test.pl | text/x-script.perl |
| test.png | image/png |
| test.pnm | application/x-portable-anymap |
| test.pnm | image/x-portable-anymap |
| test.ppm | image/x-portable-pixmap |
| test.ppt | application/msword |
| test.ps | application/postscript |
| test.psd | image/photoshop |
| test.py | text/x-python |
| test.py | text/x-script.phyton |
| test.rtf | application/rtf |
| test.rtf | application/x-rtf |
| test.rtf | text/richtext |
| test.rtf | text/rtf |
| test.sh | application/x-bsh |
| test.sh | application/x-sh |
| test.sh | application/x-shar |
| test.sh | text/x-script.sh |
| test.sh | text/x-sh |
| test.tar | application/tar |
| test.tar.gz | application/octet-stream |
| test.tar.gz | application/x-compressed |
| test.tar.gz | application/x-gzip |
| test.tga | image/x-tga |
| test.txt | text/plain |
| test.txt.gz | application/octet-stream |
| test.txt.gz | application/x-compressed |
| test.txt.gz | application/x-gzip |
| test.wav | audio/x-wav |
| test.wmf | application/x-msmetafile |
| test.wmf | windows/metafile |
| test.xcf | application/x-xcf |
| test.xml | application/xml |
| test.xpm | image/x-xbitmap |
| test.xpm | image/x-xpixmap |
| test.xpm | image/xpm |
| test.zip | application/zip |
</div>
## Package Code Metrics
``` r
cloc::cloc_pkg_md()
```
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) |
| :--- | -------: | ---: | --: | ---: | ----------: | ---: | -------: | ---: |
| R | 7 | 0.78 | 949 | 0.91 | 52 | 0.69 | 62 | 0.61 |
| JSON | 1 | 0.11 | 80 | 0.08 | 0 | 0.00 | 0 | 0.00 |
| Rmd | 1 | 0.11 | 14 | 0.01 | 23 | 0.31 | 40 | 0.39 |
## Code of Conduct

Loading…
Cancel
Save