rtiddlywiki

R interface for tiddlywiki

https://github.com/byzheng/rtiddlywiki

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    1 of 1 committers (100.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (11.6%) to scientific vocabulary

Keywords

r tiddlywki
Last synced: 10 months ago · JSON representation

Repository

R interface for tiddlywiki

Basic Info
Statistics
  • Stars: 3
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 1
Topics
r tiddlywki
Created about 4 years ago · Last pushed 10 months ago
Metadata Files
Readme Changelog License Code of conduct

README.md

[!CAUTION] This package will modify and delete tidders in Tiddlywiki. Use it with caution. Create a backup and test it before using,

rtiddlywiki

R-CMD-check CRAN_Status_Badge

R interface for tiddlywiki which is a unique non-linear notebook for capturing, organising and sharing complex information.

Communicate with WebServer API for node.js only

WebServer APIs of tiddlywiki are implemented in R interface including GET list of tiddlers by filters, a tiddler, and file; PUT a new tiddler.

```r tw_options(host = "http://127.0.0.1:8080/")

Get all tiddlers

get_tiddlers()

Get a tiddler by title

get_tiddler(title = "GettingStarted")

Put a new tiddler

title <- "New tiddler" text <- c("!! Section", "This is a new tiddler") type <- "text/vnd.tiddlywiki" tags <- c("Tag1", "Tag 2") fields <- c("field 1" = "value 1", "field 2" = "field 2") put_tiddler(title = title, text = text, type = type, tags = tags, fields = fields) ```

Generate markdown tiddler from Rmarkdown file

A new output format tiddler_document is exported to generate markdown tiddler from Rmarkdown file and then PUT into tiddlywiki WebServer. The image files generated by knitr are embeded as base64. Lazy load under Node.js can be used to load big markdown file.

Two parameter are used to specify the host of tiddlywiki server.

A new tiddler in json format is generated in the Rmd folder and can be used to import into tiddlywiki in the server or single file. The tiddler PUT into server if host is specified.

The yaml header can be specified to export tiddler_document.

yaml title: "R Markdown file" output: rtiddlywiki::tiddler_document: host: "http://127.0.0.1:8080/" tags: ["tag 1", "tag 2"] fields: "field1": "V1" "field 2": "Value 2"

The title in the Rmarkdown file is used as tiddler name.

The markdown file is generated by functions rmarkdown::md_document or bookdown::markdown_document2 if use_bookdown is specified.

Installation

Install the developing version from Github.

r devtools::install_github('byzheng/rtiddlywiki')

Owner

  • Name: Bangyou Zheng
  • Login: byzheng
  • Kind: user

Bangyou is a research scientist at CSIRO. His research interests include crop modelling, crop adaptation, high throughput phenotyp, big data and R programming.

GitHub Events

Total
  • Watch event: 1
  • Push event: 78
Last Year
  • Watch event: 1
  • Push event: 78

Committers

Last synced: about 2 years ago

All Time
  • Total Commits: 50
  • Total Committers: 1
  • Avg Commits per committer: 50.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 10
  • Committers: 1
  • Avg Commits per committer: 10.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Bangyou Zheng b****g@c****u 50
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 5 hours
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 1.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 5 hours
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 1.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • byzheng (2)
  • andjar (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 101 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
cran.r-project.org: rtiddlywiki

R Interface for 'TiddlyWiki'

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 101 Last month
Rankings
Dependent repos count: 23.9%
Stargazers count: 25.5%
Forks count: 27.8%
Dependent packages count: 28.7%
Average: 37.4%
Downloads: 81.2%
Maintainers (1)
Last synced: 10 months ago