reportingGuidelines
This repository contains the templates for research outputs (e.g. case reports, original articles, metaanlyses, reviews). This package can be used alone to quickly recall checklists from the EQUATOR webpage. The individual templates are made manually based on the published cheklists.
Many scientific reports have specific structures.
Original articles, RCTs, literature reviews and case reports are distinctly different papers.
Whenever one would start writing - it is necessary to make a structure of a specific type. Moreover, there are multiple guidelines how to efficiently (and by standardized matter) write a specific report.
So let's say I would like to write a Case report in a medical journal. The http://www.equator-network.org/ page provides the guidelines on how to write various scientific manuscripts and which information needs to be in these reports. They also recommend the best set of guidelines for the job.
We find that for the case reports the CARE guidelines are recommended. http://www.equator-network.org/reporting-guidelines/care/ Therefore we would like to write a case report using these guidelines. They provide a set of tips and checklists while writing. But finding them and using them could be easier.
This package is meant to be an extension to the rrtools by providing these guidelines as templates 'paper.Rmd' file.
How to cite
Please cite this compendium as:
Francuzik, (2018). Compendium of R code and data for 'Title of paper'. Accessed 27 Mär 2018. Online at https://doi.org/xxx/xxx
How to download or install
You can download the compendium as a zip from from this URL: https://github.com/wolass/reportingGuidelines/archive/master.zip
Or you can install this compendium as an R package, reportingGuidelines, from GitHub with:
# install.packages("devtools")
devtools::install_github("wolass/reportingGuidelines")Licenses
Text and figures : CC-BY-4.0
Code : See the DESCRIPTION file
Data : CC-0 attribution requested in reuse
Contributions
We welcome contributions from everyone. Before you get started, please see our contributor guidelines. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.