README.md

In GregorDeCillia/showdown: Show file contents in RMarkdown documents

showdown

Show file contents in RMarkdown documents with syntax highlighting

Installation

devtools::install_github("r-webutils/showdown")

Usage

Use show_file to include the contents of a file. The syntx highlighting is chosen based on the file extension.

library(showdown)
show_file("R/show_file.R")

#' show contents of a file with syntax highlighting
#'
#' @param file a path to a file to show
#' @param language the language used for syntax higlighing
#' @importFrom tools file_ext
#'
#' @export
show_file <- function(file, language = file_ext(file)) {
  content <- paste(readLines(file), collapse = "\n")
  knitr::asis_output(
    paste0(
      "```", language, "\n",
      content, "\n",
      "```"
    )
  )
}

The parameter lang can be used to manually set the syntax highlighter.

show_file("DESCRIPTION", language = "yaml")

Package: showdown
Type: Package
Title: Show file contents in RMarkdown documents
Version: 0.1.0
Author: Gregor de Cillia
Maintainer: Gregor de Cillia <[e-mail]>
Description: This package allows you to list file contents in RMarkdown
    documents. Syntax highlighting is applied according to the file extension.
License: MIT + file LICENSE
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.1.1
Imports: 
    tools,
    knitr
Roxygen: list(markdown = TRUE)
URL: https://github.com/GregorDeCillia/showdown
BugReports: https://github.com/GregorDeCillia/showdown/issues

To show the contanents of a file from GitHub, show_file_github can be used.

show_file_github(repo = "statistikat/surveysd", file = "src/compute_linear.cpp")

#include <Rcpp.h>
using namespace Rcpp;

//' @rdname computeFrac
//' @export
// [[Rcpp::export]]
NumericVector computeLinear(double curValue,
                            double target,
                            const NumericVector& x,
                            const NumericVector& w,
                            double boundLinear = 10) {
  double h = 0.0;
  double j = 0.0;
  double N = 0.0;

  for(int i = 0; i < x.size(); i++){
    h += w[i]*x[i];
    j += w[i]*x[i]*x[i];
    N += w[i];
  }

  double b = (target-N*j/h)/(h-N*j/h);
  double a = (N-b*N)/h;

  NumericVector f(x.size());
  for(int i = 0; i < x.size(); i++)
    f[i] = a*x[i] + b;

  //apply bounds
  for(int i = 0; i < x.size(); i++){
    if (f[i] < 1.0/boundLinear)
      f[i] = 1.0/boundLinear;
    if (f[i] > boundLinear)
      f[i] = boundLinear;
  }

  return f;
}

//' @rdname computeFrac
//' @export
// [[Rcpp::export]]
NumericVector computeLinearG1(double curValue,
                              double target,
                              const NumericVector& x,
                              const NumericVector& w,
                              double boundLinear = 10) {
  NumericVector f(x.size());
  f=computeLinear(curValue,target,x,w,boundLinear);
  for(int i = 0; i < x.size(); i++){
    if (f[i]*w[i] < 1.0){
      f[i]=1/w[i];
    }
  }
  return f;
}

GregorDeCillia/showdown documentation built on Dec. 28, 2021, 10:53 a.m.