Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
See what's new at GitLab
4
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Switch to GitLab Next
Sign in / Register
Toggle navigation
M
manifesto
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
27
Issues
27
List
Boards
Labels
Service Desk
Milestones
Iterations
Merge Requests
0
Merge Requests
0
Requirements
Requirements
List
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Test Cases
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Code Review
Insights
Issue
Repository
Value Stream
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
rostools
manifesto
Commits
72324b3f
Commit
72324b3f
authored
Jan 14, 2020
by
Luke Johnston
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
remove GSAW acronym
parent
f9280135
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
11 additions
and
13 deletions
+11
-13
index.Rmd
index.Rmd
+2
-2
introduction.Rmd
introduction.Rmd
+5
-7
preamble.tex
preamble.tex
+1
-1
recommendations.Rmd
recommendations.Rmd
+3
-3
No files found.
index.Rmd
View file @
72324b3f
---
title
:
"A Generalized and Structured Analytical Workflow
(GSAW) for Reproducible and Openly Scientific (ROS)
Projects"
title
:
"A Generalized and Structured Analytical Workflow
for Reproducible and Openly Scientific
Projects"
author
:
-
"Luke Johnston"
-
"Joel Östblom"
...
...
@@ -11,7 +11,7 @@ documentclass: book
biblio
-
style
:
apalike
link
-
citations
:
yes
#
github
-
repo
:
description
:
"Heavily Opinionated Manifesto on Reproducible and Open Science Projects"
description
:
"
A
Heavily Opinionated Manifesto on Reproducible and Open Science Projects"
---
\
mainmatter
...
...
introduction.Rmd
View file @
72324b3f
# Manifesto for ROS Projects {#ros-manifesto}
TODO: Need to incorporate the GSAW or other acronym throughout the manifesto
```{r, child="preamble-note.md"}
```
...
...
@@ -108,8 +106,8 @@ Our philosophy is to encourage reproducible and open scientific practices by
automating and streamlining many aspects of a ROS project and by providing an
opinionated view on which tools, services, and workflows to use when doing
research. The goal is to reduce the burden on researchers and lower the barrier
to doing open and reproducible science by creating a
Generalized and S
tructured
Analytical Workflow (GSAW)
.
to doing open and reproducible science by creating a
generalized and s
tructured
analytical workflow and approach to research projects
.
For now, we are focusing on typical scientific activities such as creating
abstracts, slides, posters, and manuscripts. We aim to incorporate creating
...
...
@@ -151,7 +149,7 @@ When a tool and/or service is mostly equal, consider that:
### Guiding principles on workflow and processes
Likewise, for the analysis and workflow
(the GSAW)
aspect of ROS, we follow
Likewise, for the analysis and workflow aspect of ROS, we follow
these guiding principles:
- Favour readability over concision
...
...
@@ -192,7 +190,7 @@ being in the "Advanced" stage.
### Phases of a research project
To help navigate the recommendations and steps for a
GSAW-
ROS project, phases
To help navigate the recommendations and steps for a ROS project, phases
of a research project are split into:
- Project management throughout (specifically regarding files, folders)
...
...
@@ -203,7 +201,7 @@ of a research project are split into:
- Dissemination
All current and future tools, services, and workflows incorporated into a
GSAW-
ROS project template must be based on these guiding principles and
ROS project template must be based on these guiding principles and
considerations.
TODO: Include guiding principles for creating teaching material
preamble.tex
View file @
72324b3f
...
...
@@ -5,7 +5,7 @@
\title
{
\normalfont
\horrule
{
1pt
}
\\
[0.4cm]
\huge
A Generalized and Structured Analytical Workflow
(GSAW) for Reproducible and Openly Scientific (ROS)
Projects
\huge
A Generalized and Structured Analytical Workflow
for Reproducible and Openly Scientific
Projects
\horrule
{
1pt
}
\\
[0.5cm]
}
...
...
recommendations.Rmd
View file @
72324b3f
...
...
@@ -11,13 +11,13 @@ some comparisons between options.
Open science encompasses a vast number of diverse tools and services that is
continuously increasing. This encouraging growth indicates that open science is
actively evolving and that there is a rich network of people and organizations
devoted to improving current scientific practices. A downside to this
plenty
is
that i
s
can act as a barrier for researchers who desire to work more in the
devoted to improving current scientific practices. A downside to this
abundance
is
that i
t
can act as a barrier for researchers who desire to work more in the
open. The range of tool choices and the lack of guidance on what to use
particularly risks to overwhelm and discourage researchers seeking to open up
their workflow for the first time.
To provide a solution to this problem, the
GSAW-
ROS framework provides heavily
To provide a solution to this problem, the ROS framework provides heavily
opinionated recommendations on open tools, workflows, and services. Below is a
brief summary of the specific recommendations we make, followed by more detailed
explanations and comparisons between tools, services, and workflows.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment