ctuning / reproindex

[OUTDATED] Index of reproduced papers with reusable research components and unified workflows. Moved to

Home Page:https://github.com/reproindex/ck-reproindex

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

compatibility

Data license: License: CC BY 4.0 Code license: License

Compatibility: Linux, MacOS, Windows

Description

This repository contains cross-linked research components and reproducible papers in the CK format.

Installation

Install CK as described here.

Create a fork of this repository at GitHub to be able to send PRs.

Pull the forked repository via CK:

$ ck pull repo:reproindex --url={URL of the forked repository}

Adding new article with reusable research

$ ck add repro.article

Answer ~12 questions about the article (you can just press Enter when a question is not applicable). You can also find related answers in meta.json files of already shared articles. You can use an existing event tag or add a new one there.

CK will then create a new entry with the article meta description. You can commit your changes to your forked repo as follows:

$ ck find repo:reproindex
$ cd `ck find repo:reproindex`
$ git commit
$ git push

You can now create a PR for this repository. We will then review and update it if needed. When accepted, we will update this repository at reuseresearch.com to make your changes available to the community in a user-friendly way.

Updating reusable research components

Feel free to update meta description of other components and send us a PR:

Indexing new CK components:

You can index new CK components as follows:

  • CK modules: ck index component.module:{CK module name} --share
  • CK repositories: ck index component.repo:{CK repo name} --share
  • CK software detection plugins: ck index component.soft:{CK soft name} --share
  • CK packages: ck index component.package:{CK package name} --share
  • CK tasks (program workflows): ck index component.program:{CK program name} --share

You can then commit your changes and send us a PR as described above:

$ ck find repo:reproindex
$ cd `ck find repo:reproindex`
$ git commit
$ git push

Feedback

Feel free to provide your feedback and suggestions to help us improve this index and the website, and make it more useful and convenient to researchers!

About

[OUTDATED] Index of reproduced papers with reusable research components and unified workflows. Moved to

https://github.com/reproindex/ck-reproindex

License:Other


Languages

Language:Python 93.5%Language:HTML 6.5%