My Research Tool Example

Template metadata for REMARKs

Abstract

References

Reference in APA style

Details

Authors

Abstract

Replication of Paper X

Actions

Live Interactive Notebook

This material includes a Jupyter Notebook version. You can directly launch and interact with the Notebook within your browser using MyBinder via the "Launch" button(s) below.

Binder badge logo

Launch Dashboard

This material includes an interactive dashboard. The dashboard is a Jupyter Notebook which utilizes the Voila extension. You can directly launch the dashboard within your browser using MyBinder.

Launch Dashboard

Material Source Code

Econ-ARK materials are open source and available to view and clone from GitHub.

View on GitHub

View Paper

An electronic version of the research paper associated with this material is avaiable to view and download.

View Paper

How to Execute this Notebook (with conda)

Install miniconda on your computer

  1. Open a Terminal (MacOS) or the Anaconda Prompt (Windows)
  2. At a command line, change the working directory to the one where you want to install
    • On MacOS/unix, if you install in the /tmp directory, the repo will disappear at reboot:
    • cd /tmp
  3. git clone Link to git repo hosting the code --recursive
  4. cd Link to git repo hosting the code
  5. conda env create -f ./binder/environment.yml --prefix ./condaenv
    • This creates ./condaenv inside your clone of the repo, containing dependencies.
  6. conda run --prefix ./condaenv pip install jupyterlab
  7. conda run --prefix ./condaenv jupyter-lab

Metadata

Edit metadata

Key Value
abstract Replication of Paper X
authors {"family-names"=>"Holmes", "given-names"=>"Mycroft", "orcid"=>"https://orcid.org/XXXX-XXXX-XXXX-XXXX"}
cff-version 1.1.0
dashboards path_to_dashboard.ipynb
date-published-original-paper
date-released
github_repo_url Link to git repo hosting the code
identifiers {"type"=>"url", "value"=>"URL to project page"}
{"type"=>"doi", "value"=>"DOI link if available"}
identifiers-paper {"type"=>"url", "value"=>"template"}
{"type"=>"doi", "value"=>"doi:template"}
keywords Econ-ARK
Sample
Template
message If you use this software, please cite it as below.
notebooks path_to_notebook.ipynb
references {"authors"=>[{"family-names"=>"Author 1 Last Name", "given-names"=>"Author 1 First Name", "orcid"=>"https://orcid.org/XXXX-XXXX-XXXX-XXXX"}, {"family-names"=>"Author 2 Last Name", "given-names"=>"Author 2 First Name", "orcid"=>"https://orcid.org/XXXX-XXXX-XXXX-XXXX"}], "date"=>"20XX-XX-XX", "doi"=>"Original paper DOI", "publisher"=>"Publisher information", "title"=>"Title of original paper", "type"=>"article"}
remark-name template
repository URL of repository
tags REMARK
Notebook
title-original-paper Name of the paper if available
version 1.0.4
date