You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
boB Rudis a3813cd8fa
cinc
10 months ago
R initial commit 10 months ago
inst/tinytest R package repo initialization complete 10 months ago
man initial commit 10 months ago
tests R package repo initialization complete 10 months ago
.Rbuildignore initial commit 10 months ago
.codecov.yml R package repo initialization complete 10 months ago
.gitignore R package repo initialization complete 10 months ago
.travis.yml R package repo initialization complete 10 months ago
CONDUCT.md R package repo initialization complete 10 months ago
DESCRIPTION initial commit 10 months ago
LICENSE initial commit 10 months ago
LICENSE.md initial commit 10 months ago
NAMESPACE initial commit 10 months ago
NEWS.md R package repo initialization complete 10 months ago
README.Rmd R package repo initialization complete 10 months ago
README.md cinc 10 months ago
countenance.Rproj R package repo initialization complete 10 months ago

README.md

Project Status: Active – The project has reached a stable, usablestate and is being activelydeveloped. Signedby Signed commit% Linux buildStatus
Minimal RVersion License

countenance

Tools to Work with the Pi-Hole API

Description

Named after a primary synonym for ‘pihole’, tools are provided to access the Pi-Hole API.

What’s Inside The Tin

The following functions are implemented:

  • pi_fwd_dest: Get forward destinations (i.e. upstream DNS)
  • pi_host: Get or set PIHOLE_HOST value
  • pi_key: Get PIHOLE_API_KEY value
  • pi_over_time_10m: Get recent 10 min time series counts
  • pi_queries: Get query types distribution
  • pi_query_types: Get query types distribution
  • pi_recent: Get recent blocked
  • pi_summary: Get summary stats
  • pi_test: Test connectivity to/get info about a Pi-Hole
  • pi_top_clients: Get top clients
  • pi_top_items: Get top items

Installation

install.packages("countenance", repos = c("https://cinc.rud.is", "https://cloud.r-project.org/"))
# or
remotes::install_git("https://git.rud.is/hrbrmstr/countenance.git")
# or
remotes::install_git("https://git.sr.ht/~hrbrmstr/countenance")
# or
remotes::install_gitlab("hrbrmstr/countenance")
# or
remotes::install_bitbucket("hrbrmstr/countenance")
# or
remotes::install_github("hrbrmstr/countenance")

NOTE: To use the ‘remotes’ install options you will need to have the {remotes} package installed.

Usage

library(countenance)

# current version
packageVersion("countenance")
## [1] '0.1.0'

countenance Metrics

Lang # Files (%) LoC (%) Blank lines (%) # Lines (%)
R 15 0.94 207 0.96 119 0.89 90 0.76
Rmd 1 0.06 8 0.04 15 0.11 28 0.24

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.