Git Product home page Git Product logo

ck-reproindex's Introduction

compatibility

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

Compatibility: Linux, MacOS, Windows

Description

This repository contains reusable and cross-linked research components from reproduced 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:ck-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:ck-reproindex
$ cd `ck find repo:ck-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:ck-reproindex
$ cd `ck find repo:ck-reproindex`
$ git commit
$ git push

Notes

How to customize URL:

Feedback

This community project is in very early stage and there is still a lot to be done. We need your participation and feedback to improve our open-source technology and make it more convenient for researchers and engineers. Please submit your issues and request features at https://github.com/reproindex/ck-reproindex/issues .

Feel free to register at the ReproIndex website and sign up to our twitter to keep track of the latest news. You are also very welcome to participate in this standardization effort via our Slack channel and this public discussion group.

ck-reproindex's People

Contributors

gfursin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.