Skip to content

README Guide

Seth Erickson edited this page Jul 16, 2019 · 3 revisions

You can add additional documentation to ScholarSphere work pages by including a README file in your deposit. ScholarSphere accepts plain text (README.txt) and markdown (README.md) README files. After uploading the file, you may need to refresh the page for the contents of the README to appear.

README template

The template below can be copy-and-pasted into a text file, preferably named README.md or README.txt, and expanded as needed. Text that appears in comment tags (<!-- like this --->) is meant as guidance for README authors and should not be included in the final version. It is best to use a plain text editor such as TextEdit (Mac), Notepad (Windows), Sublime, Atom, or Visual Studio Code.

The template uses Markdown formatting. You can read more about markdown here. It is based on Cornell's excellent Guide to "Readme" Style Metadata.

*This README.md file was generated on YYYYMMDD by NAME*
<!-- remove all comments (like this) before final save  -->

General Information
------------------

### Title:

*Data and Code for "Against Lorem Ipsum: A History of Filler Text"*

### Author Information:

- Principal Investigator:
- Associate or Co-investigator:
- Alternate Contact(s):

### Date of data collection/creation:
<!-- (single date, range, approximate date. Suggested format YYYYMMDD -->

### Geographic location of data collection:
<!--City, State, County, Country and/or GPS Coordinates or bounding boxes--> 

### Funders and sponsors of data collection:



Sharing/Access Information
--------------------------

### License & restrictions on data reuse:
<!-- Creative Commons Attribution 4.0 International (CC BY 4.0)  -->

### Recommended citation for the data:
<!-- suggested: Creator (PublicationYear). Title. Publisher. Identifier -->

### Related publications:
<!-- Citation for and links to publications that cite or use the data -->

### Links to other publicly accessible locations of the data:
<!-- for example, GitHub repo -->

### Related data sets: 


Data & File Overview
--------------------

### File list:
<!-- list files with brief descriptions -->

### Additional notes:

<!-- 
Relationship between files, if important for context:
Additional related data collected that was not included in the current data package:
If data was derived from another source, list source:
If there are there multiple versions of the dataset, list the file updated, when and why update was made:
Software- or instrument-specific information needed to interpret the data, including software and hardware version numbers:
-->
  
File/Format-Specific Information
--------------------------------
<!--Create sections for each datafile or set, as appropriate-->

### `fig1.r`
- Code Usage: 

### `sample2/*.csv`
- Number of variables:
- Number of cases/rows: 
- Variable list, defining any abbreviations, units of measure, codes or symbols used:
- Missing data codes:
- Specialized formats or other abbreviations used:


Methodological Information
--------------------------

<!-- 
Description of methods used for collection/generation of data: <Include links or references to publications or other documentation containing experimental design or protocols used in data collection>
Methods for processing the data: <describe how the submitted data were generated from the raw or collected data>
Standards and calibration information, if appropriate:
Environmental/experimental conditions:
Describe any quality-assurance procedures performed on the data:
People involved with sample collection, processing, analysis and/or submission: 
-->

Clone this wiki locally
You can’t perform that action at this time.